Skip to content

Commit db5d746

Browse files
committed
docs(contributing): require a Linear or GitHub issue on pull requests
Pull requests could omit a tracker link. Every pull request now has to name a Linear or GitHub issue with one of the existing magic words.
1 parent 53fc0e8 commit db5d746

1 file changed

Lines changed: 11 additions & 5 deletions

File tree

‎CONTRIBUTING.md‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -197,14 +197,18 @@ Rules:
197197
under the Summary section (not a separate heading).
198198
- Scan for past-tense journey verbs (`was`, `added`, `fixed`, `refactored`,
199199
`I changed`) and rewrite to present-tense product statements.
200-
- When the work tracks an issue, end the body with a magic-word link (see
201-
below). When it does not, omit the link line entirely — do not invent IDs.
200+
- End the body with a magic-word link to a Linear or GitHub issue (see
201+
below). One of those magic words is required. Do not invent issue IDs.
202202

203203
GitHub auto-fills this shape from `.github/PULL_REQUEST_TEMPLATE.md`.
204204

205205
## Issue tracking (Linear and GitHub)
206206

207-
Link trackers at the **PR boundary**, not inside every commit.
207+
Every pull request must reference a Linear issue or a GitHub issue. Link
208+
trackers at the **PR boundary**, not inside every commit. The pull-request body
209+
must include one of the magic words documented below (`Fixes`, `Refs`, or
210+
another closing or non-closing word in those lists). Do not invent issue IDs
211+
or a new issue-id format.
208212

209213
### When work tracks a Linear issue (MUST)
210214

@@ -249,9 +253,11 @@ Same pattern in the PR body:
249253
Fixes #123
250254
```
251255

252-
### When there is no tracker
256+
### When there is no tracker yet
253257

254-
Omit magic words. Do not invent issue IDs.
258+
Open a Linear or GitHub issue first, then reference it from the pull-request
259+
body with one of the magic words above. Do not omit the link, and do not
260+
invent issue IDs.
255261

256262
### At PR-open (SHOULD)
257263

0 commit comments

Comments
 (0)