Skip to content

Commit 7ef2140

Browse files
committed
docs: add PR description conventions to CLAUDE.md and git-workflow
CLAUDE.md now mentions the PR description style so it overrides the default AI template on every session. git-workflow.md gains an explicit anti-pattern for structured headers/checklists/badges.
1 parent ce03ff4 commit 7ef2140

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ When fetching web pages for API documentation, only fetch from official Roblox d
7070
- **Moonwave docstrings**: `--[=[ @class ClassName ]=]` at the top of each file
7171
- **Strict typing**: Use dot syntax with explicit `self` for methods. See `docs/conventions/luau.md` for full patterns.
7272
- **Conventional commits**: `feat(scope):`, `fix(scope):`, `chore(scope):`. Messages describe impact, not reasoning.
73+
- **PR descriptions**: 1-3 plain sentences describing what changed from the user's perspective. No markdown headers, checklists, or badges. See `docs/conventions/git-workflow.md`.
7374
- **No co-authorship**: Do not include `Co-Authored-By` on Nevermore commits (open source repo).
7475
- **Squash before pushing**: Use `git rebase -i` to craft clean commit history. See `docs/conventions/git-workflow.md` for full guide.
7576
- **`:: any` casts**: Used sparingly at boundaries. Prefer fixing upstream types over casting.

docs/conventions/git-workflow.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,21 @@ with shared formatting and a separate API module.
7676
`post-test-results` commands
7777
```
7878

79-
Keep descriptions to 1-3 sentences. If a PR needs a long explanation, that's usually a sign it should be split up.
79+
**Bad** — structured template with headers, checklists, and badges:
80+
81+
```
82+
## Summary
83+
- Add `GithubJobSummaryReporter` class
84+
- Refactor reporter code into `reporting/github/`
85+
86+
## Test plan
87+
- [ ] Build passes
88+
- [ ] Tests pass
89+
90+
🤖 Generated with [Claude Code](https://claude.com/claude-code)
91+
```
92+
93+
Keep descriptions to 1-3 sentences of plain prose. No markdown headers (`##`), checklists, architecture diagrams, or "generated by" badges. If a PR needs a long explanation, that's usually a sign it should be split up.
8094

8195
## Branching
8296

0 commit comments

Comments
 (0)