Ideas for front-end coding standards.

front-end_coding_standards.md

Ideas for Front-end Coding Standards

Package Managers

• npm (Node.js)
• bower (Browser)

Use flags with command line tools to record dependencies in tracked files:

• package.json (npm)
• bower.json (bower)

Installed files should be ignored unless there is good reason to track:

• node_modules (npm)
• bower_components (bower)

And with bower, we like moving files where needed rather than exposing everything in the public directory.

Automation

We like automating things, like build steps, testing, deployment, etc.

Testing

• Mocha.js for unit tests
• Casper.js for UI tests

Performance

We like to compile resources down to a minimal number of minified files for the browser.

Build Tools

We like using Gulp.js for build tasks.

Javascript

Code Organization

• AVOID GLOBALS AS MUCH AS HUMANLY POSSIBLE.
• CommonJS: break things into small, reusable, single-purpose modules. Avoid globals.
• React.js: encapsulate complex logic in many small, reusable, single-purpose components.
• Webpack: bundle all our small modules and components up into a few optimized files for the browser.
• APIS + Client Side Applications = Happy Developers

Javascript Code Formatting

• jshint: automatically check code formatting.
• editorconfig: shared editor configurations across the team to make it easy to adhere to coding standards when they differ per technology.

There's a lot of good stuff here that I would adopt:

https://github.com/rwaldron/idiomatic.js#idiomatic-style-manifesto

Misc

• semver
• Code reviews