Skip to content

Commit 57e4859

Browse files
committed
docs(maintenance): mirror illustrative-scopes wording in PR template
Match the wording adopted in docs/agents/contributing.md so that human contributors and AI agents see the same guidance in both places. Assisted-By: Claude <[email protected]> Signed-off-by: Aleksei Sviridkin <[email protected]>
1 parent e52cf38 commit 57e4859

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
<!-- Thank you for making a contribution! Here are some tips for you:
22
- Use Conventional Commits for the PR title: `type(scope): description`
33
- Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore
4-
- Scopes for system components: dashboard, platform, cilium, kube-ovn, linstor, fluxcd, cluster-api
5-
- Scopes for managed apps: postgres, mariadb, redis, kafka, clickhouse, virtual-machine, kubernetes
6-
- Scopes for development and maintenance: api, hack, tests, ci, docs, maintenance
4+
- Scopes are not an exhaustive list — pick the most specific scope for the change and extend the list when a genuinely new area appears. Examples:
5+
- System components: dashboard, platform, operator, cilium, kube-ovn, linstor, fluxcd, cluster-api
6+
- Managed apps: postgres, mariadb, redis, kafka, clickhouse, virtual-machine, kubernetes
7+
- Development and maintenance: api, hack, tests, ci, docs, maintenance
78
- Breaking changes: append `!` after type/scope (`feat(api)!: ...`) or add a `BREAKING CHANGE:` footer
89
- If it's a work in progress, consider creating this PR as a draft.
910
- Don't hesistate to ask for opinion and review in the community chats, even if it's still a draft.

0 commit comments

Comments
 (0)