[Docs] Document Conventional Commit Scopes in Git Workflow Guide
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 5
- Forks
- 7
- Avg merge
- 39m
- Merged PRs (30d)
- 39
Description
- Labels:
good first issue,documentation,difficulty:beginner,area:core - Target File:
docs/GIT_WORKFLOW.md - Estimated Time: 5–10 minutes
- Difficulty: Level 1 (Beginner)
Why This Matters
PACT uses Conventional Commits (e.g., feat(planner): ..., ui(habits): ...). Documenting valid commit scopes helps contributors format their PR commits accurately.
Current Behavior
docs/GIT_WORKFLOW.md outlines commit types (feat, fix, docs, ui), but does not provide a reference list of common scopes (planner, finance, habits, focus, a11y, auth).
Requested Change
Add a concise table in docs/GIT_WORKFLOW.md listing recommended scope names corresponding to PACT's feature modules.
Acceptance Criteria
- Scope table added to
docs/GIT_WORKFLOW.md. - Scopes match existing directories in
src/features/.
Verification
node scratch/check-links.mjs
Contributor Notes
Markdown-only issue.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Edit docs/GIT_WORKFLOW.md and inspect the existing directories under src/features/ to confirm the recommended scopes. Add the concise scope table described in the acceptance criteria, then run node scratch/check-links.mjs; done means the table is present and its scopes match the feature directories.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, node.js, typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 95/100