Skip to content

Latest commit

 

History

History
24 lines (19 loc) · 1.14 KB

File metadata and controls

24 lines (19 loc) · 1.14 KB

Code comments

Keep code comments succinct. The goal of code comments is to help readability by explaining the current code and/or giving some intuitive reasoning. This can use an example. Code comments should not include git history, or issue numbers or historical facts.

Process conventions

  • Keep PRs small and single-purpose. Split a PR that mixes multiple objectives (e.g. a rename + unrelated behavior change) into separate PRs so the repo stays runnable and reviewable at every merge point.
  • PR titles follow Conventional Commits: <type>(<scope>): <summary>, e.g. fix(precompute): ..., feat(query-engine): ..., refactor(asap-tools): ..., perf(precompute): .... Match the existing scope names used in this repo's PR history (precompute, query-engine, planner, asap-tools, sql-parser, deps, etc.) rather than inventing new ones.
  • Never amend commits unless the user explicitly asks. Always create a new commit instead.

Code design and test coverage

See .agents/skills/code-design-review.md and .agents/skills/test-coverage-review.md — apply them while writing code, not just when asked to review.