Preparing for Code Review

Name: preparing-review
Rating: 87
Author: kecbigmt

Pre-Commit Checklist

code

Before Commit:
- [ ] Developer verification complete
- [ ] All tests pass
- [ ] Linting passes
- [ ] Story log updated

Commit Granularity

CRITICAL: One intent per commit. Split by "why" not "what".

❌ FORBIDDEN:

bash

git add .  # Groups unrelated changes
git commit -m "add feature X and refactor Y"

✅ REQUIRED:

bash

git add src/feature.ts tests/feature.test.ts
git commit -m "feat: enable feature X"

git add src/utils.ts
git commit -m "refactor: extract common logic"

Commit Message

CRITICAL: Explain WHY, not WHAT (diff shows what)

Format: <type>(<scope>): <summary> + body

Types: feat, fix, refactor, test, docs, chore

Good:

code

feat(sync): enable GitHub backup for notes

Users need version control. Initializes repo for that.

Bad (avoid):

code

feat(sync): add git init
^^ Only what, not why it matters

Guidelines:

•Title: what + value (imperative, ≤50 chars)
•Body: problem solved, context, user benefit
•Never restate code changes

Push

bash

git push -u origin <branch>  # first time
git push                      # subsequent

Create PR

Use pr-template skill for PR structure and guidelines.