Skip to content

[DOCS] Simplify PR title syntax toward Conventional Commits #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
John McCall (lowlydba) wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

[DOCS] Simplify PR title syntax toward Conventional Commits #6

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7003c26
[DOCS] Simplify PR title syntax toward Conventional Commits
lowlydba Jul 2, 2026
8b861c9
[DOCS] Drop investigation type from PR title table
lowlydba Jul 2, 2026
ee1f851
[DOCS] Drop security type, fold into fix per Conventional Commits
lowlydba Jul 2, 2026
b22e6d4
[DOCS] Add previous-type column to PR title table
lowlydba Jul 2, 2026
707c331
[DOCS] Revert previous-type column in PR title table
lowlydba Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 13 additions & 16 deletions docs/pull-request-checks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ In addition to the workflow checks below, all PRs also require a passing [DCO ch

### Fix a failing PR title check

Edit the PR title to match `[TYPE] Description`. The comment posted on the PR clears automatically once the title passes.
Edit the PR title to match `type: description` (see [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)). The comment posted on the PR clears automatically once the title passes.

To skip the check for automated or exceptional PRs, add a `bot` or `ignore-semantic-pull-request` label.

Expand All @@ -32,27 +32,24 @@ Leave a comment, push a commit, or remove the `stale` label. Any of these reset
### PR title format

```text
[TYPE] Short description of the change
[TYPE](scope) Short description of the change
[BREAKING][TYPE] Short description of the change
type: Short description of the change
type(scope): Short description of the change
type(scope)!: Short description of the change
```

The optional `(scope)` narrows the area of the codebase affected (e.g. `[REFACTOR](schema) Consolidate validation logic`).
PR titles follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) syntax. The optional `(scope)` narrows the area of the codebase affected (e.g. `refactor(schema): consolidate validation logic`). A `!` before the colon marks a breaking change (e.g. `feat(api)!: remove deprecated endpoint`).

Use `[WIP]` as a prefix on repos without draft PR support.

| Type | Use for |
|---|---|
| `BUG` | Fixing a defect |
| `FEATURE` | Adding new functionality |
| `ENHANCEMENT` | Improving existing functionality |
| `DOCS` | Documentation-only changes |
| `REFACTOR` | Code restructuring without behavior change |
| `TEST` | Adding or updating tests |
| `CHORE` | Maintenance, dependency updates, tooling |
| `PERFORMANCE` | Performance improvements |
| `SECURITY` | Security fixes or hardening |
| `INVESTIGATION` | Exploratory or spike work |
| `fix` | Fixing a defect (including security fixes, e.g. `fix(security): sanitize user input`) |
| `feat` | Adding new functionality or improving existing functionality |
| `docs` | Documentation-only changes |
| `refactor` | Code restructuring without behavior change |
| `test` | Adding or updating tests |
| `chore` | Maintenance, dependency updates, tooling |
| `perf` | Performance improvements |

### Staleness thresholds

Expand All @@ -71,7 +68,7 @@ Overture has contributors across many repos and organizations. Without consisten

### Why title format matters

A consistent title format makes changelogs, release notes, and search useful without manual categorization. The `[TYPE]` prefix is machine-readable and gives reviewers immediate context when triaging a queue of open PRs.
A consistent title format makes changelogs, release notes, and search useful without manual categorization. The Conventional Commits `type` prefix is machine-readable and gives reviewers immediate context when triaging a queue of open PRs.

### Why linked issues are required

Expand Down
Loading