Repository navigation
Add pre-review PR checklist and description check - #25496
Conversation
Replace the PR template with an author checklist to complete before requesting review, each item with validation steps for agents. A new Check PR description workflow blocks merge until every checklist item is ticked and the visible description is at most 3,000 characters. AI-7189
evalya-impact-summaryevalya impact analysis |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 905b5541e2
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
AAraKKe
left a comment
There was a problem hiding this comment.
Thanks @dkirov-dd! Added some comments, the one I would strongly request is removing the workflow and script from this pr and not regress on the effort on simplifying CI and rogue scripts in the repo. We have enough and want to move out of them, adding more is a blocker for me since it is against what we have discussed multiple times already. Agents love to do this because there is precedent but we need to stop them from doing this.
✅ Dispatcher tests: passed
✅ 2 passed · nothing failed Batches · ✅ batch-01 2/2 Dispatcher finished on |
|
✅ All CI checks and tests passed. Datadog automation helped this PR pass. 🎉 All green!🧪 All tests passed 🔄 Datadog retried 127 tests - 2 passed on retry 🎯 Code Coverage (details) 🔗 Commit SHA: 45d2852 | Docs | View more details | Give us feedback! |
AAraKKe
left a comment
There was a problem hiding this comment.
Thanks @dkirov-dd! Two small requests
Review from AAraKKe is dismissed. Related teams and files:
- agent-integrations
- ddev/src/ddev/cli/validate/pr_description.py
Review from AAraKKe is dismissed. Related teams and files:
- agent-integrations
- ddev/tests/cli/validate/test_pr_description.py
Validation ReportAll 22 validations passed. Show details
|
* Add pre-review PR checklist and description check Replace the PR template with an author checklist to complete before requesting review, each item with validation steps for agents. A new Check PR description workflow blocks merge until every checklist item is ticked and the visible description is at most 3,000 characters. AI-7189 * Trim checklist to judgment items and add human-author attestation * Limit QA skip default to code owned exclusively by agent-integrations * Never use qa/required for code owned exclusively by agent-integrations * Test the PR description check against the real template * Drop PR description check tests and log why the check is skipped * Exempt PRs opened before the checklist template from the description check * Require the template's checklist items instead of any ticked task * Link the human-author item to CONTRIBUTING.md and update its PR standards * Drop the CONTRIBUTING.md standards lead-in * Link the human-author item to AGENTS.md and restore CONTRIBUTING.md * Describe the PR description check as failing, not blocking merge * Move PR description check into ddev * Rewrap the PR template checklist comment * Enable the pr-description validation for integrations-core * Apply review feedback to the PR template and AGENTS.md * Detect bot authors by GitHub user type * Pass the GitHub event to pr-description through options instead of env in tests * Read the current PR description from the API so re-runs see edits * Fetch the PR description with the async GitHub client and re-run validations on edits * Move enforced time up to be in line with time of merge * Derive pr-description test dates from ENFORCED_SINCE * Set ENFORCED_SINCE to 2026-10-08 00:00 UTC 419abeb
Checklist before requesting review
What does this PR do?
Replaces the PR template with a short checklist authors complete before requesting review, modeled on
DataDog/cloud-inventory. It only covers what CI can't check:Each item has a hidden
Validationcomment so coding agents can verify it. CI, the changelog, and the QA label are left to their existing checks.Adds a
pr-descriptionddev validation (ddev validate pr-description, run byRun Validations) that fails only when a template checklist item is missing or unticked, or the visible description (HTML comments excluded) exceeds 3,000 characters. It is not a required check, so it never blocks merge. It skips bot-authored and release PRs, and PRs opened before the template change (ENFORCED_SINCE). Repos without the checklist in their template are skipped.validate.ymlnow also runs onedited, so editing the description re-runs validations. The same rules apply to everyone; it does not try to detect AI-assisted PRs.Updates the
AGENTS.mdPull Requests section to match:Motivationhow the change fits in, linking only the references a reviewer needsqa/skip-qa; otherwise agents ask the userMotivation
AI-7189: make AI-assisted (and all) PRs easier to review with short, standardized descriptions and pre-review checks done by the author, with a human accountable for each PR.
Before merge: set
ENFORCED_SINCEto the merge date.