Axon Shaft docs
Templates

Strict review

Every check, small suggestions as inline comments, and any untested change counts as blocking.

  • Kind: Code review
  • Category: Reviews
  • 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. Security: Secrets, injection, unchecked input, weaker auth, unsafe workflow changes.
  4. Tests: Changed behaviour without a test, or a test that can never fail.
  5. Docs: A change users can see with no docs or README update.
  6. The repo's standards: Naming, file layout and patterns the repo already uses, and helpers it already has.
  7. Does what it says: Changes the pull request doesn't mention, parts it claims but leaves out, and pull requests that should be split.
  8. Pull request basics: The title format, the pull request template's sections, a linked issue and the size against the repo's limit.
  9. Changelog and changeset: A published package changed with no changeset or changelog entry, or with the wrong version bump.
  10. Dependencies: Added, removed and upgraded packages, major bumps, packages in the wrong dependency list and packages nothing imports.
  11. Known vulnerabilities: Added or changed package versions with a published security advisory.
  12. Licences: New dependencies with a strong copyleft licence, or with no licence.
  13. Supply chain: Install scripts in new packages, git or URL dependencies, a new registry and names one letter off a popular package.
  14. Secrets: Keys, tokens and private keys in added lines.
  15. Personal data and logs: Personal data, tokens or payment data sent to logs, analytics, error reports or URLs.
  16. Access control: Whether each new route or handler checks who may call it, including who owns the IDs it takes, tenant isolation and roles.
  17. Failure handling: Timeouts on network calls, retries only on work that is safe to repeat, cleanup on error and partial writes.
  18. Logs and metrics: New failure paths nobody would see, noisy logs in hot paths and lost trace or request IDs.
  19. Performance: N+1 queries, awaits in loops, unbounded queries or lists and slow work in hot paths and renders.
  20. Feature flags: A risky change with no flag in a repo that uses flags, a flag that ships turned on and flags nothing reads.
  21. Config and env vars: New env vars or config keys missing from the example env file, the docs or the config schema.
  22. Type safety: New any types, unsafe casts, ignored type errors, non-null assertions and missing type hints in typed Python.
  23. Unused code: New exports nothing imports, new files nothing reaches and commented-out code.
  24. File and folder structure: New files against the repo's naming and folder rules.
  25. Unchecked generated code: Imports of modules or APIs that don't exist, made-up options, boilerplate comments and unrelated rewrites.
  26. Public API: Removed or renamed exports, changed signatures and breaking changes with no major version bump.
  27. HTTP and schema contracts: Breaking changes in OpenAPI, GraphQL or protobuf schemas.
  28. Database migrations: Migrations that lock tables, lose data or break the running version, and hand-written ones where the repo generates them.
  29. Schema and migration in step: A schema file changed with no migration in the same pull request, or a migration with no schema change.
  30. GitHub workflows: Workflows that run pull request code with secrets, untrusted input in run steps, unpinned actions and wide permissions.
  31. Containers: Secrets in image layers or build args, running as root, unpinned base images and ports open on every address.
  32. Infrastructure as code: Public buckets, open security groups, wildcard IAM, no encryption and no resource limits.
  33. Accessibility: Labels, roles and alt text, keyboard and focus, touch target size and accessibility labels in React Native.
  34. Translations: Hard-coded text people see in a repo that has translations, keys missing from a locale and dates or numbers formatted by hand.
  35. Theme and design tokens: Raw colours, spacing and font sizes where the repo has tokens, dark mode left out and breaks from the repo's theming guide.
  36. React patterns: Hook rules, effect dependencies, list keys, state in the wrong place and needless re-renders.
  37. Native and store: Permissions and privacy manifest entries, config plugins, native changes with no runtime version bump and code that handles only one platform.

Last updated on