Skip to content

Commit 98c0159

Browse files
committed
docs: add PR description conventions to CLAUDE.md and git-workflow
1 parent 89520a8 commit 98c0159

File tree

2 files changed

+5
-15
lines changed

2 files changed

+5
-15
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: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -58,25 +58,14 @@ PR descriptions are for reviewers and future readers browsing git history. They
5858
**Good** — says what changed from the user's perspective:
5959

6060
```
61-
Test and deploy results now appear on the GitHub Actions run summary
62-
page in addition to PR comments.
61+
Test and deploy results now appear on the GitHub Actions run summary page in addition to PR comments.
6362
64-
Also reorganizes the GitHub reporter code into `reporting/github/`
65-
with shared formatting and a separate API module.
63+
Also reorganizes the GitHub reporter code into `reporting/github/` with shared formatting and a separate API module.
6664
```
6765

68-
**Bad** — restates the diff:
66+
Keep descriptions to 1-3 sentences of plain prose. No markdown headers, checklists, or "generated by" badges. If a PR needs a long explanation, that's usually a sign it should be split up.
6967

70-
```
71-
- Add `GithubJobSummaryReporter` that writes batch test/deploy results
72-
to `$GITHUB_STEP_SUMMARY`
73-
- Refactor GitHub reporter code into a `reporting/github/` subfolder
74-
with shared formatting extracted into `formatting.ts`
75-
- Wire up the new reporter in `batch test`, `batch deploy`, and
76-
`post-test-results` commands
77-
```
78-
79-
Keep descriptions to 1-3 sentences. If a PR needs a long explanation, that's usually a sign it should be split up.
68+
The best PRs include a demo — a screenshot or short video showing the change in action. This is especially valuable for UI changes, new CLI output, or CI improvements where the effect isn't obvious from code alone.
8069

8170
## Branching
8271

0 commit comments

Comments
 (0)