8. Contributing

How the code is written, how changes flow, and how a release is cut.

• 8.1. Coding conventions
  • 8.1.1. Line length
  • 8.1.2. Comments
  • 8.1.3. Docstrings
  • 8.1.4. Typing
  • 8.1.5. File headers
  • 8.1.6. Naming
  • 8.1.7. Vendored code
  • 8.1.8. Fail-closed, in code
• 8.2. Development flow
  • 8.2.1. Branches
  • 8.2.2. Commits
  • 8.2.3. Tests
  • 8.2.4. Documentation
• 8.3. Release process
  • 8.3.1. Overview
  • 8.3.2. Versioning
  • 8.3.3. Which release is running?
  • 8.3.4. Branch layout
  • 8.3.5. Which fixes go on a release branch?
  • 8.3.6. Cutting a patch release (vX.Y.Z)
  • 8.3.7. Cutting a new minor release (vX.Y.0)
  • 8.3.8. After tagging: propagate the release to main
  • 8.3.9. Before tagging: check the tree
  • 8.3.10. Rules of thumb