Skip to content

Style Guide

Dana Silver edited this page Jun 8, 2016 · 4 revisions

The linter must pass.

$ npm run lint

Why?

"All code in any code-base should look like a single person typed it, no matter how many people contributed."

~ idiomatic.js

Commits

  • Commit anytime a feature or part of a feature has been created, fixed, updated, etc. If things pile up, git add individual files and git commit them with a message about the changes in each
  • Commit messages should be descriptive. They can be one-liners, but should give a sense of the particular change made and the document where the change was made
  • Extensive changes or multiple changes warrant a multiline commit message
  • If a commit requires more than just pulling (example: running a migration), note it
  • If you can fetch and rebase instead of a merge with a merge commit, try to do that
  • Commit messages are written in the present tense. As much as possible, they should be sentences:

Add helper functions to get actual model instances from a relationship.

Clone this wiki locally