Skip to content

Commit 9050e5a

Browse files
priya-sundaram-devpriya-sundaram-dev
authored
docs(skill): make the PR checkbox rule a hard final gate (#15237)
* docs(skill): make the PR checkbox rule a hard final gate The requirement to tick at least one checklist box was buried in a prose paragraph, so PR bodies generated straight from the template kept going out with every box empty and algorithms-keeper auto-closed them before a human could read them. Promote the rule to an explicit 'Before you click Create pull request' final gate with a re-read/verify step, and spell out that it applies to every PR (CI, docs, tooling) — tick the boxes that genuinely apply so the body is never all-empty. * docs(skill): wrap long line to satisfy MD013 (350-char limit)
1 parent 6a539de commit 9050e5a

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

‎.github/skills/new-pull-request/SKILL.md‎

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,13 @@ hand. A hand-modified `uv.lock` makes the `algorithms-keeper` bot close the pull
1919
request as invalid, and even a repo maintainer cannot undo that.
2020

2121
Always check at least one Markdown checkbox in the pull request description (the "Describe your change" section), or the
22-
`algorithms-keeper` bot will close the pull request as invalid. Any repo maintainer can undo this if you @mention them on the closed pull request.
22+
`algorithms-keeper` bot will close the pull request as invalid — and it does
23+
this *before* a human reads the PR, so a genuinely good change gets closed for a
24+
formatting reason. This applies to **every** pull request, including CI, docs,
25+
and tooling changes that are not algorithms: tick the boxes that genuinely apply
26+
so the body is never submitted with all boxes empty. Any repo maintainer can
27+
undo this if you @mention them on the closed pull request, but re-opening is
28+
often unreliable, so it is far better to get it right the first time.
2329

2430
### 1. Before contributing / Is this an algorithm?
2531

@@ -55,3 +61,15 @@ Always check at least one Markdown checkbox in the pull request description (the
5561
- [ ] At least one **Wikipedia (or equivalent) URL** documenting the algorithm.
5662
- [ ] Docstring explains what the function does and its parameters/returns.
5763
- [ ] No unnecessary third-party dependencies.
64+
65+
## Before you click "Create pull request"
66+
67+
This is the final gate. Do not open the pull request until every item here is true:
68+
69+
- [ ] At least one Markdown checkbox in the PR description is checked. **Verify
70+
this by re-reading the rendered body** — if every box is still `- [ ]`, the
71+
`algorithms-keeper` bot will auto-close the PR before any human sees it.
72+
Check the boxes that genuinely apply to this change; never submit an
73+
all-empty checklist, even for a CI, docs, or tooling PR.
74+
- [ ] The branch is not `master`, and `master` is synced with `upstream/master`.
75+
- [ ] `uv.lock` was not hand-edited.

0 commit comments

Comments
 (0)