Axon Shaft docs
Templates

Monorepo

For monorepos, where a change crosses packages and each release has to name the right ones.

  • Kind: Code review
  • Category: By project type
  • Added to new projects: No

Checklists, in order

  1. Correctness: Logic errors, missing awaits, off-by-one, empty and null cases, races.
  2. What else it can break: Callers, exports and configs elsewhere in the repo that the change didn't update.
  3. Public API: Removed or renamed exports, changed signatures and breaking changes with no major version bump.
  4. Changelog and changeset: A published package changed with no changeset or changelog entry, or with the wrong version bump.
  5. File and folder structure: New files against the repo's naming and folder rules.
  6. The repo's standards: Naming, file layout and patterns the repo already uses, and helpers it already has.
  7. Tests: Changed behaviour without a test, or a test that can never fail.
  8. Docs: A change users can see with no docs or README update.
  9. Dependencies: Added, removed and upgraded packages, major bumps, packages in the wrong dependency list and packages nothing imports.
  10. Known vulnerabilities: Added or changed package versions with a published security advisory.
  11. Secrets: Keys, tokens and private keys in added lines.

Last updated on