chore: add PR validation workflow and update contributing guidelines

[fallenbagel]

Description

We've been getting an increasing number of PRs that completely ignore the PR template with no description, no testing details, unchecked checklists, and AI-generated descriptions that replace our template with their own format. This adds an automated PR template validation check that labels non-compliant PRs as blocked and comments with what's missing. It also updates the contributing guide to make it explicit that ignoring the PR template may result in closure without review.

How Has This Been Tested?

Screenshots / Logs (if applicable)

Checklist:

• I have read and followed the contribution guidelines.
• Disclosed any use of AI (see our policy)
• I have updated the documentation accordingly.
• All new and existing tests passed.
• Successful build pnpm build
• Translation keys pnpm i18n:extract
• Database migration (if required)

Summary by CodeRabbit

• Documentation

  • Strengthened contribution guidelines with explicit AI-disclosure rules, a detailed PR checklist, clearer mandatory template sections, and stricter expectations; maintainers may close incomplete PRs

• Chores

  • Added an automated PR Validation workflow enforcing semantic titles and PR-template checks, posting bot comments and toggling a blocking label as needed; removed the prior semantic PR workflow
  • Added a CLI PR-body validator to enforce description, testing, checklist, and disclosure requirements

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 2c98b226-2540-408f-8e32-09a52b6b8b09

📥 Commits

Reviewing files that changed from the base of the PR and between cad6e3a and fa7aab2.

📒 Files selected for processing (4)

• .github/workflows/pr-validation.yml
• .github/workflows/semantic-pr.yml
• CONTRIBUTING.md
• bin/check-pr-template.mjs

💤 Files with no reviewable changes (1)

• .github/workflows/semantic-pr.yml

✅ Files skipped from review due to trivial changes (2)

• CONTRIBUTING.md
• .github/workflows/pr-validation.yml

🚧 Files skipped from review as they are similar to previous changes (1)

• bin/check-pr-template.mjs

---

📝 Walkthrough

Walkthrough

Adds a PR validation GitHub Actions workflow that validates semantic PR titles and enforces PR template compliance via a Node.js checker; removes the old semantic-pr workflow; and tightens CONTRIBUTING.md rules for AI disclosure and PR template adherence.

Changes

Cohort / File(s)	Summary
New PR validation workflow ​.github/workflows/pr-validation.yml	Adds pull_request_target workflow with two jobs: semantic-title (runs amannn/action-semantic-pull-request) and template-check (runs bin/check-pr-template.mjs, upserts/deletes bot comments, and manages blocked:template label).
Removed legacy workflow ​.github/workflows/semantic-pr.yml	Deletes the previous standalone semantic PR workflow that validated conventional PR titles.
PR template validator script bin/check-pr-template.mjs	New Node CLI that validates PR body sections (## Description, ## How Has This Been Tested?, ## Checklist), enforces specific checkboxes (including conditional AI disclosure based on author association), detects unresolved Fixes #XXXX`` placeholders, emits JSON issues and sets exit codes.
Contribution guidance CONTRIBUTING.md	Expands AI assistance/disclosure policy: adds a checklist for detecting unreviewed AI output, requires PR-template-compliant descriptions and in-PR AI disclosure, and defines contributor expectations and rejection criteria.

Sequence Diagram(s)

sequenceDiagram
  participant Contributor
  participant GH_Actions as "GitHub Actions (runner)"
  participant NodeScript as "bin/check-pr-template.mjs"
  participant GH_API as "GitHub API (comments/labels)"

  Contributor->>GH_Actions: open/reopen/edit/synchronize PR
  GH_Actions->>GH_Actions: run semantic-title job
  GH_Actions->>GH_Actions: run template-check job (skipped on synchronize)
  alt PR author is bot
    GH_Actions-->>Contributor: skip validation
  else non-bot author
    GH_Actions->>NodeScript: run checker with PR body
    NodeScript-->>GH_Actions: return exit code + issues JSON
    alt issues found
      GH_Actions->>GH_API: upsert bot comment "### Issues found"
      GH_Actions->>GH_API: add or create `blocked:template` label
      GH_Actions-->>GH_Actions: fail job
    else no issues
      GH_Actions->>GH_API: remove `blocked:template` label (if present)
      GH_Actions->>GH_API: delete bot comment (if present)
    end
  end

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~30 minutes

Possibly related PRs

• ci: add semantic-pr workflow to enforce conventional commits #2472: Previously adjusted or added semantic PR title validation workflows (directly related to workflow replacement).
• chore: update contributing guide regarding Automated AI Agent #2518: Overlapping edits to CONTRIBUTING.md about AI assistance/disclosure policy.
• ci: update concurrency logic #2481: Related changes to workflow concurrency/PR-run cancellation keys.

Suggested reviewers

• M0NsTeRRR
• sudo-kraken
• gauthier-th

"🐇 I hopped in swift to guard the gate,
Titles checked and templates up to date.
Tell if AI helped, and mark what's true,
A tidy note and label if issues brew.
Hooray for checks that keep the code in view!"

🚥 Pre-merge checks | ✅ 2

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main changes: adding a PR validation workflow and updating contributing guidelines, matching the primary objectives.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Adds automated PR metadata enforcement to reduce low-effort/non-template PR submissions by validating PR titles and PR-template completeness via GitHub Actions, and updates contributor guidance to set expectations around template compliance and AI disclosure.

Changes:

• Add a PR Validation workflow that enforces semantic PR titles and validates PR template completion (labeling/commenting on failures).
• Introduce a Node-based PR body validator script (bin/check-pr-template.mjs) used by the workflow.
• Expand CONTRIBUTING.md guidance around PR template compliance and AI disclosure expectations; remove the old standalone semantic-pr workflow.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.

File	Description
bin/check-pr-template.mjs	New script to parse PR body and report missing/placeholder sections and unchecked required checklist items.
CONTRIBUTING.md	Clarifies AI assistance disclosure requirements and sets stricter expectations for filling out the PR template.
.github/workflows/semantic-pr.yml	Removes the legacy standalone semantic PR title workflow (replaced by consolidated validation workflow).
.github/workflows/pr-validation.yml	New consolidated workflow: semantic title check + PR template validation with automatic labeling/commenting.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[coderabbitai]

Actionable comments posted: 5

🧹 Nitpick comments (1)

.github/workflows/pr-validation.yml (1)

90-99: Mark the bot comment explicitly before updating or deleting it.

Matching any bot comment that contains ### Issues found: is too broad. This can overwrite or delete an unrelated automation comment. Add a workflow-specific marker to commentBody and match on that marker instead.

Suggested fix

+            const COMMENT_MARKER = '<!-- pr-template-validation -->';
             const issueList = issues.map(i => `- ${i}`).join('\n');
 
             const commentBody = [
+              COMMENT_MARKER,
               `Hey @${author}, thanks for submitting this PR! However, it looks like the PR template hasn't been fully filled out.\n`,
               `### Issues found:\n`,
               issueList,
@@
             const botComment = comments.data.find(
-              c => c.user.type === 'Bot' && c.body.includes('### Issues found:')
+              c => c.user.type === 'Bot' && c.body.includes(COMMENT_MARKER)
             );
@@
             const botComment = comments.data.find(
-              c => c.user.type === 'Bot' && c.body.includes('### Issues found:')
+              c => c.user.type === 'Bot' && c.body.includes(COMMENT_MARKER)
             );

Also applies to: 108-110, 184-185

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In @.github/workflows/pr-validation.yml around lines 90 - 99, The bot's
commentBody (variable commentBody) currently uses a generic marker `### Issues
found:` which is too broad and risks matching unrelated automation comments;
update the commentBody to include a unique workflow-specific marker (e.g., a
short, unique token or HTML comment like `<!-- pr-validation-bot: v1 -->`) and
then change any comment-matching/updating logic to look for that exact marker
instead of `### Issues found:`; apply the same change to the other commentBody
instances referenced in the review so every workflow-specific bot comment has
the unique marker used for safe updates/deletes.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/workflows/pr-validation.yml:
- Line 86: The workflow is using a generic LABEL constant ('blocked') that this
job later unconditionally removes; change LABEL to a workflow-owned name (e.g.,
'pr-template-blocked' or similar) and update all uses (the const LABEL and every
place that adds/removes it) so the job only touches that workflow-specific
label; additionally, when removing the label, guard the removal so it only
removes labels the workflow actually added (for example by checking the label
name matches the workflow-owned name or verifying the label was created/added by
the bot/this workflow) rather than unconditionally removing a generic 'blocked'
label.

In `@bin/check-pr-template.mjs`:
- Around line 19-22: The maintainer exemption implemented by MAINTAINER_ROLES
and isMaintainer lets OWNER/MEMBER/COLLABORATOR bypass the AI-disclosure
checkbox, which conflicts with CONTRIBUTING.md; either remove the exemption
logic or make it explicit in the guide. Update the code around MAINTAINER_ROLES
/ isMaintainer (and any checks that use isMaintainer) to require the AI
disclosure for all authors by removing/ignoring this maintainer whitelist, or if
you must keep it, add a clear comment and link to the documented exemption and
adjust CONTRIBUTING.md to describe the exception; ensure
process.env.AUTHOR_ASSOCIATION is still read but no longer used to skip
AI-disclosure validation (or document the exemption in the guide).
- Around line 24-29: The replacement only strips triple-dash comments (`<!---
... --->`) so template placeholders like `<!-- ... -->` remain and make empty
sections appear non-empty; update the comment-stripping regex used when building
descriptionContent (and the equivalent replacement at the other location
handling "How Has This Been Tested?") to match standard HTML comments (use a
pattern that matches `<!-- ... -->`, e.g., `<!--[\s\S]*?-->` with the same
flags) and ensure both occurrences (the logic around
descriptionMatch/descriptionContent and the similar testing-section variable)
use that corrected regex before trimming and checking emptiness.

In `@CONTRIBUTING.md`:
- Around line 66-69: Fix the typo in the maintainer-review paragraph by
replacing the garbled phrase "isn not a maintainers job" with the correct
wording, e.g., "isn't a maintainer's job" (or "is not a maintainer's job") so
the sentence reads clearly; update the string containing that sentence in the
CONTRIBUTING.md paragraph where the phrase appears.
- Around line 41-48: The blockquote examples are split by blank lines
(triggering MD028); remove the empty lines inside each example so each
blockquote is a single contiguous quoted paragraph—specifically make the three
example lines starting with "> **AI Disclosure:**" contiguous (no blank lines
between the '>' lines) so each example is one continuous blockquote.

---

Nitpick comments:
In @.github/workflows/pr-validation.yml:
- Around line 90-99: The bot's commentBody (variable commentBody) currently uses
a generic marker `### Issues found:` which is too broad and risks matching
unrelated automation comments; update the commentBody to include a unique
workflow-specific marker (e.g., a short, unique token or HTML comment like `<!--
pr-validation-bot: v1 -->`) and then change any comment-matching/updating logic
to look for that exact marker instead of `### Issues found:`; apply the same
change to the other commentBody instances referenced in the review so every
workflow-specific bot comment has the unique marker used for safe
updates/deletes.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 12935931-2574-4035-a8af-5ba07cfafc05

📥 Commits

Reviewing files that changed from the base of the PR and between 56b79ff and ab05dc4.

📒 Files selected for processing (4)

• .github/workflows/pr-validation.yml
• .github/workflows/semantic-pr.yml
• CONTRIBUTING.md
• bin/check-pr-template.mjs

💤 Files with no reviewable changes (1)

• .github/workflows/semantic-pr.yml

[coderabbitai]

Actionable comments posted: 1

♻️ Duplicate comments (1)

CONTRIBUTING.md (1)

68-68: ⚠️ Potential issue | 🟡 Minor

Fix possessive typo in maintainer-review sentence.

Line 68 should use possessive form: maintainer's (or maintainers', if plural possessive is intended).

Suggested fix

-is not a maintainers job to review a PR so broken that it requires
+is not a maintainer's job to review a PR so broken that it requires

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CONTRIBUTING.md` at line 68, Replace the non-possessive phrase "is not a
maintainers job to review a PR so broken that it requires" with the correct
possessive form; change to either "is not a maintainer's job to review a PR so
broken that it requires" (singular) or "is not a maintainers' job to review a PR
so broken that it requires" (plural) depending on the intended meaning, updating
the sentence containing the exact phrase "is not a maintainers job to review a
PR so broken that it requires".

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@bin/check-pr-template.mjs`:
- Around line 29-30: The current .replace call that removes the placeholder ("-
Fixes `#XXXX`") is too strict; update both .replace(...) usages (the calls that
currently use /- Fixes `#XXXX/g`) to use a case-insensitive pattern that matches
variants with optional surrounding backticks/quotes/dashes and arbitrary
whitespace (e.g., accepts "Fixes `#XXXX`", "`fixes  `#XXXX``", "- fixes `#XXXX`",
etc.), then trim as before; apply the same change to the second occurrence
around lines 77-79 so all placeholder variants are removed reliably.

---

Duplicate comments:
In `@CONTRIBUTING.md`:
- Line 68: Replace the non-possessive phrase "is not a maintainers job to review
a PR so broken that it requires" with the correct possessive form; change to
either "is not a maintainer's job to review a PR so broken that it requires"
(singular) or "is not a maintainers' job to review a PR so broken that it
requires" (plural) depending on the intended meaning, updating the sentence
containing the exact phrase "is not a maintainers job to review a PR so broken
that it requires".

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5d511490-6345-4403-832d-d8190460ade7

📥 Commits

Reviewing files that changed from the base of the PR and between ab05dc4 and c20b8f9.

📒 Files selected for processing (4)

• .github/workflows/pr-validation.yml
• .github/workflows/semantic-pr.yml
• CONTRIBUTING.md
• bin/check-pr-template.mjs

💤 Files with no reviewable changes (1)

• .github/workflows/semantic-pr.yml

🚧 Files skipped from review as they are similar to previous changes (1)

• .github/workflows/pr-validation.yml

[Copilot]

Pull request overview

Copilot reviewed 3 out of 4 changed files in this pull request and generated 6 comments.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.