Skip to content

docs: improve PR title format hint in PR template and CONTRIBUTING.md (#286) #287

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

Merged
ncarenton merged 1 commit into from
Jun 10, 2026
Merged

docs: improve PR title format hint in PR template and CONTRIBUTING.md (#286) #287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@ Thank you very much for your pull request to the OpenAEV project! We as a commun
driven project depend on support and contributions like this!

Thus already a BIG THANK YOU upfront to you for choosing to help with your PR.

PR TITLE FORMAT (enforced by CI):
type(scope?)!?: description (#123)
- type: feat | fix | chore | docs | style | refactor | perf | test | build | ci | revert
- scope: optional, e.g. affected module or area
- description: must start with a lowercase letter
- (#123): required linked issue number
Comment thread
ncarenton marked this conversation as resolved.
Example: feat(client): add bulk export endpoint (#42)
-->

### Proposed changes
Expand Down
15 changes: 9 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,15 @@ in [`.github/LABELS.md`](.github/LABELS.md). In short:

* **Titles** — All commit, pull request and issue titles follow the
[Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
specification with a GitHub issue reference:
`type(scope?)!?: description (#issue)` (e.g.
`feat(api): add bulk export endpoint (#1234)`). The description starts with a
lowercase letter and has no trailing period; preserve acronyms and proper
nouns. Types: `feat`, `fix`, `chore`, `docs`, `style`, `refactor`, `perf`,
`test`, `build`, `ci`, `revert`.
specification with a GitHub issue reference. PR title format (enforced by CI):
```
type(scope?)!?: description (#123)
```
- **type**: one of `feat`, `fix`, `chore`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `revert`
- **scope**: optional — use the affected module or area (e.g. `client`, `api`)
- **description**: must start with a lowercase letter, no trailing period; preserve acronyms and proper nouns
- **`(#123)`**: required — the linked issue number at the end
- Examples: `feat(client): add bulk export endpoint (#42)`, `fix: resolve config loading issue (#99)`
Comment thread
ncarenton marked this conversation as resolved.

* **No more bracket prefixes** — The old `[backend]` / `[frontend]` /
`[component]` prefixes are **discontinued**; use a Conventional Commits scope
Expand Down
Loading