Skip to content

docs: use one Closes keyword per issue in PR template #72

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
subotic merged 1 commit into from
Mar 20, 2026
Merged

docs: use one Closes keyword per issue in PR template #72

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions docs/commit-conventions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ not found in the workspace root.

```
Closes #<issue-number>
Closes #<issue-number>

## Motivation
Why this work was needed. What problem it solves for users.
Expand Down Expand Up @@ -109,6 +110,22 @@ actionable -- not just "this is hard" but "do X instead of Y".
- [ ] verification steps
```

### Closing issues

Use one `Closes` keyword per issue, each on its own line. Do NOT
comma-separate multiple issues on one line — GitHub may silently
skip some of them.

```
# Good
Closes #39
Closes #40
Closes #41

# Bad — GitHub may not close all of them
Closes #39, #40, #41
```

### Why this format matters
The "Challenges and Decisions" section captures the debugging journey
that would otherwise be lost when commits are squashed. The
Expand Down
Loading