Code Monkey home page Code Monkey logo

Comments (2)

jwflory avatar jwflory commented on May 30, 2024

Discussed in 2020-03-07 meeting.


For the v2.x.x release, this issue is not about linting (see #256). The code style code is a one-page doc that covers more semantics that are specific to our project. To track this, a list of those things is below:

  • Naming conventions
  • Patterns for writing new handlers
  • Interfaces

from teleirc.

jwflory avatar jwflory commented on May 30, 2024

Discussed in 2020-04-11 meeting.


I updated the issue title to focus more on what this is. Since our CI pipeline already enforces things like gofmt and golint, style is not a huge concern for documentation. However, the "human" semantics of how we do things like in the last post are better examples of what goes into a doc like this.

To reiterate, this doc will probably not be very long. If we keep to the three sections outlined in the last comment, it might be 2-3 sentences for each section. It should not be a very verbose doc.

from teleirc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.