Axon Shaft docs
Templates

Library or npm package

For published packages, whose users depend on the public API and the release notes.

  • 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. Public API: Removed or renamed exports, changed signatures and breaking changes with no major version bump.
  3. What else it can break: Callers, exports and configs elsewhere in the repo that the change didn't update.
  4. Tests: Changed behaviour without a test, or a test that can never fail.
  5. Changelog and changeset: A published package changed with no changeset or changelog entry, or with the wrong version bump.
  6. Docs: A change users can see with no docs or README update.
  7. Type safety: New any types, unsafe casts, ignored type errors, non-null assertions and missing type hints in typed Python.
  8. Dependencies: Added, removed and upgraded packages, major bumps, packages in the wrong dependency list and packages nothing imports.
  9. Licences: New dependencies with a strong copyleft licence, or with no licence.
  10. Supply chain: Install scripts in new packages, git or URL dependencies, a new registry and names one letter off a popular package.
  11. Secrets: Keys, tokens and private keys in added lines.

Last updated on