@sinet/coding-conventions

About

We each play an important role in the success of the products we build in both the short and long term. When development groups are small and limited to just a few individuals, who often work in silos, refactoring, maintaining, and extending our code is easy; we wrote it and intimately know it! However, this becomes a challenge in a larger group, as each developer on a team, and each team will have their own conventions and standards. Conventions include file organization, indentation, comments, declarations, statements, white space, naming conventions, programming practices, programming principles, programming rules of thumb, architectural best practices, etc.

Much of our development time is spent reading code and exploring a project. This is especially true when a project is completed and falls into maintenance, we are fixing bugs, or working on projects we did not create. We read code to understand a project, to find patterns so we can refactor, to find bugs, etc. Most of our time is spent reading code!

Early on in the development of the new platform, we recognized the need for consistency. A lot of time was spent on developing coding conventions and project standards. If conventions are mixed throughout a project or between projects, it affects the readability and ease of understanding. It’s understood that not every standard chosen is the easiest to implement, but they meet the goals of maintainability, readability, extendability and familiarity. Some people may feel that the particular style or standard is wrong, but it should be followed because consistency is far more important.

As an organization, we need to write code for humans and not machines.

Coding Conventions and Standards

• JavaScript
• HTML
• CSS / Less
• iOS

Additional Reading

The following three books are great reference for this topic. It is highly recommend that everyone read them:

• The Art of Readable Code
• Code Simplicity
• Code Complete (2nd Edition)

Setup / Configuration

Using terminal, download the following linting and editor configuration files in your project directory:

curl -O https://raw.githubusercontent.com/sinet/coding-conventions/master/.editorconfig
curl -O https://raw.githubusercontent.com/sinet/coding-conventions/master/.eslintrc

Install these packages for Sublime Text 3

• EditorConfig
• SublimeLinter
• SublimeLinter-eslint
• DocBlockr