Skip to content

Latest commit

 

History

History
13 lines (11 loc) · 857 Bytes

dev-norms.md

File metadata and controls

13 lines (11 loc) · 857 Bytes

Norms

Developer norms are a necessary way to set some ground rules, so your code base can retain some consistency, remain maintainable over the next days, months and years and all developers are on the same page.

Here's a starter list of developer norms:

  1. Don't over-engineer. Write minimum code to get things working end to end, only then iterate to improve,
  2. Use a Continuous Integration server,
  3. Always push working code, if you break the pipeline/build then fix it,
  4. Make granular and small commits, per feature or per bug fix,
  5. Provide descriptive commit messages,
  6. Write self documenting code. Use descriptive variable and function names. Avoid unnecessary name shortening,
  7. Don't leave dead/commented out code behind. If you see such code, delete it,
  8. Write automated tests to cover critical integration points and functionality.