Skip to content

check-prs: remind about missing PR descriptions - #497

Merged
p-linnane merged 1 commit into
mainfrom
pr-description-reminder
Oct 10, 2026
Merged

p-linnane merged 1 commit into
mainfrom
pr-description-reminder

Conversation

@p-linnane

Copy link
Copy Markdown
Contributor

Template-only pull requests now get one comment asking for a short description, which is removed once one is added. Unlike a missing template, this doesn't close them.

GPT-6 Astra wrote the change and tests. Claude Opus 5.5 reviewed it, re-ran the tests and tested the description detection against recent pull requests in each repository.

Signed-off-by: Patrick Linnane <patrick@linnane.io>
Copilot AI balanced review requested due to automatic review settings October 10, 2026 17:21

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The implementation matches the stated behavior and includes comprehensive lifecycle coverage.

0 open findings

What changed in this PR

Adds reminders for pull requests that retain the template but lack a meaningful description.

Changes:

  • Detects description text while ignoring checklist-only changes and comments.
  • Posts and removes a single reminder as descriptions change.
  • Adds workflow-level tests covering lifecycle and repository-specific behavior.
File Description
.github/​workflows/​check-prs.yml Manages missing-description reminders.
.github/​scripts/​check_template.rb Detects content beyond the template.
.github/​actions/​sync/​test-template-workflows.sh Runs the new test suite.
.github/​actions/​sync/​test-pr-descriptions.rb Tests detection and workflow transitions.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@MikeMcQuaid MikeMcQuaid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@p-linnane
p-linnane merged commit fcc239e into main Oct 10, 2026
28 checks passed
@p-linnane
p-linnane deleted the pr-description-reminder branch October 10, 2026 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants