Repository navigation
Check PR descriptions, and close the ones nobody fills in - #156
Merged
Merged
Conversation
Most student PRs arrive with the template headings untouched: 'Fixes #' with no number, no What, nothing about testing (#147, #144, #139, #136 today). Reviewers can't act on those, and the linked issue never closes. - pr-description.yml: on open/edit, comments with exactly what's missing, labels the PR, and says it will be closed in 2 days. Editing the description re-runs it; the comment turns into a tick. - pr-description-sweep.yml: daily, re-checks labelled PRs and closes the ones still unfixed after the grace period, explaining that nothing is lost and how to reopen. Has a dry-run mode. - A description written as prose instead of the template passes, as long as it says what changed and how it was tested.
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Most student PRs arrive with the template untouched —
Fixes #with no number, no What, nothing about testing. Today that was #147, #144, #139 and #136. Reviewers can't act on them, and the linked issue never closes, so it stays "taken" and nobody else can pick it up. I've been nudging each one by hand; this does it automatically, the moment the PR is opened, before a reviewer has to.What
pr-description.yml— on open/edit/push, comments with exactly what's missing, labels the PRneeds-description, and says it will be closed in 2 days. Editing the description re-runs the check and the comment turns into a ✅. It never runs PR code: it reads the description through the API and checks out only this repo's scripts.pr-description-sweep.yml— daily, re-checks every labelled PR and closes only those still unfixed after the grace period, with a comment explaining that nothing is lost and how to reopen. Has a dry-run mode (workflow_dispatch).What counts as filled in
Fixes #<number>line (Closes/Resolvesalso fine).npm run lint/test/build, "tested", "screenshot", …Tested
Rules run against all 12 open PRs: 8 pass, 4 fail — exactly the four I'd flagged by hand, no false positives. Plus 9 synthetic cases (empty, template-untouched,
Fixes #with no number, prose without headings, template hints only, thin sections). Both workflows parse; lint clean.