Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (21 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

33 lines (21 loc) · 1.78 KB

Contributing to the Engineering Handbook

This repo is the canonical source for branching strategy, commit convention, and release process — so this file is about contributing to the handbook itself, not a copy of the rules documented inside it.

For the rules, see:

How to contribute

This is a documentation repo, so the contribution model is the same as any other repo I own, just applied to prose instead of code.

  1. Branch from develop — docs/<short-topic> or chore/<short-topic> as appropriate.
  2. Edit existing chapters when possible; only add a new doc under docs/ when a topic is substantial enough to stand alone.
  3. Commit with Conventional Commits — most changes will be docs: or chore:.
  4. Open a PR targeting develop.
  5. CI (Lint, Commit Lint) must pass before merging.

What belongs where

  • Philosophies (docs/philosophies/) — durable why content. Principles that justify decisions. Changes slowly.
  • Workflows (docs/workflows/) — concrete how content. Steps, commands, tooling. Changes as tools evolve.
  • Tooling (docs/tooling/) — what I use and how it fits together. Start at docs/tooling/dev-tooling-stack.md.
  • Design notes (docs/design/) — brainstorm-level proposals. Not polished specs.

If a note is truly repo-specific (only applies to one project), it belongs in that repo, not here. If it applies to all my repos, it belongs here.

Releases

This repo uses the same release ceremony as every other repo I own — documented in the workflow doc linked above.