diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f239906..0756d5c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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 + Example: feat(client): add bulk export endpoint (#42) --> ### Proposed changes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33b43fb..17851e5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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)` * **No more bracket prefixes** — The old `[backend]` / `[frontend]` / `[component]` prefixes are **discontinued**; use a Conventional Commits scope