Repository navigation
Conversation
Adds a single Title Convention section to CONTRIBUTING.md and points AGENTS.md, the docs site, the issue forms and the PR template at it. Adds a minimal PR title check (pull_request event, no permissions, no checkout, title passed via env).
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The promised direct Title Convention link is missing from the documentation-site contributing page.
Review effort: Balanced
Findings: 1
What changed in this PR
Centralizes title conventions and adds automated PR-title validation.
Changes:
- Defines one canonical title format and allowed types.
- Adds a secure, event-driven PR title check.
- Updates templates with conventional prefixes and guidance.
| File | Description |
|---|---|
CONTRIBUTING.md |
Defines the canonical title convention. |
AGENTS.md |
References the canonical convention. |
.github/workflows/pr-title.yml |
Validates PR titles. |
.github/pull_request_template.md |
Adds title guidance. |
.github/ISSUE_TEMPLATE/user_story.yml |
Prefills feat:. |
.github/ISSUE_TEMPLATE/question.yml |
Prefills docs:. |
.github/ISSUE_TEMPLATE/feature_request.yml |
Prefills feat:. |
.github/ISSUE_TEMPLATE/epic.yml |
Prefills feat:. |
.github/ISSUE_TEMPLATE/bug_report.yml |
Prefills fix:. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| ## Title Convention | ||
|
|
||
| This section is the single source of truth for issue, pull request, and commit titles in this repository. `AGENTS.md`, the pull request template, the issue forms, and the documentation site point here instead of restating the rules. |
This branch has not been deployed
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.
Closes #1979
What changes
CONTRIBUTING.md: new Title Convention section, the single source of truthAGENTS.md, docs-site contributing page, PR template: point to it instead of restating rules.github/workflows/pr-title.yml: format + allowed-type check with an example on failureVerification (local)
!, release-please and Dependabot titles, missing prefix, unknown/uppercase type, empty description, trailing period, quotes/backticks/$(...)injection attempts) all behave as expectedThis PR is not merged as part of this change. After it merges and the check runs green on
main, register PR title as a required status check.