General principles for developing flexible, durable and sustainable code.
All code in any code base should look like a single person typed it, no matter how many people contributed.
This means strictly enforcing these agreed upon guidelines at all times. For additions or contributions, please file an issue on GitLab.
Working on a development team is kind of like having roommates... messy roommates... every so often, you're going to have to wash the dishes that they left in the sink while you were out of town.
Generally, you should leave all code better off than when you started, so if you find code that violates any of the rules in these guides while completing your story... clean it up. And, if practical, clean up commits should be separate from story commits.
Code is written and maintained by people. Ensure your code is descriptive, well commented, and approachable by others.
Great code comments convey context or purpose. Be sure to write in complete sentences for larger comments and succinct phrases for general notes.
Soft tabs of four (4) spaces should be used to indent code.
Opinions vary, but this can be a very pragmatic way of flagging non-urgent code issues.
The next time someone touches that file, they can consider opportunistically addressing the refactor.
TODO comments should start with TODO and include the author of the comment:
// TODO(ekapowski): Stop referring to this private field in subclasses.
var _foo = bar;Always write copy, including headings and code comments, in sentence case. In other words, aside from titles and proper nouns, only the first word should be capitalized.
Set your editor to the following settings to avoid common code inconsistencies and dirty diffs:
- Use soft-tabs set to four spaces.
- Trim trailing white space on save.
- Set encoding to UTF-8.
- Add new line at end of files.
Consider documenting and applying these preferences to your project's .editorconfig file.
- HTML code guide
- CSS code guide
- SASS code guide
- JavaScript code guide
Heavily inspired by mdo, the GitHub Styleguide and css-tricks.