gitea/pull_request_template.md at 0530b46a3ba27dfd491aecb202b66b26db727756

mirror of https://github.com/go-gitea/gitea.git synced 2026-05-06 05:55:22 +00:00

Files

Nicolas 45ffe5aa6a ci: lint PR titles with commitlint (#37498 )

## Summary
- Enforce **Conventional Commits** on PR titles (PRs are squash-merged,
so the PR title becomes the final commit message).
- Add a local `make lint-pr-title` target so contributors can validate
titles before pushing.

## Why
We squash-merge PRs, which means the final repository history is largely
shaped by **PR titles**. Enforcing a consistent Conventional Commits
format makes:
- **Release notes & changelogs easier to generate** (types like `feat` /
`fix` can be grouped automatically).
- **History easier to scan** (uniform structure, optional scopes,
explicit breaking changes via `!`).
- **Automation more reliable** (future tooling can infer category and
scope from the title).

## PR title format
```text
type(scope)!: subject
type: one of build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test
scope: optional (e.g. web, api, actions, repo, …)
!: optional, indicates a breaking change
subject: short, imperative, no trailing period
```

## Examples
```text
feat(web): add dark mode toggle
fix(api): avoid panic when repo is missing
chore(ci): lint PR titles with commitlint
refactor(templates): reduce duplication in repo list rendering
feat!: remove legacy OAuth endpoint
```

## Local testing
```text
make deps-frontend
make lint-pr-title PR_TITLE="feat(web): add dark mode toggle"
```

---------

Signed-off-by: Nicolas <bircni@icloud.com>
Co-authored-by: nb <nb@users.noreply.local>
Co-authored-by: GPT-5.2 <gpt-5.2@openai.com>

2026-05-05 17:24:09 +00:00

868 B

Raw Blame History

Please check the following:

Make sure you are targeting the main branch, pull requests on release branches are only allowed for backports.
Use a Conventional Commits PR title, for example fix(repo): handle empty branch names.
Make sure you have read contributing guidelines: https://github.com/go-gitea/gitea/blob/main/CONTRIBUTING.md .
For documentations contribution, please go to https://gitea.com/gitea/docs
Describe what your pull request does and which issue you're targeting (if any).
It is recommended to enable "Allow edits by maintainers", so maintainers can help more easily.
Your input here will be included in the commit message when this PR has been merged. If you don't want some content to be included, please separate them with a line like ---.
Delete all these tips before posting.

868 B Raw Blame History

868 B

Raw Blame History