|
1 | 1 | <!-- Thank you for making a contribution! Here are some tips for you: |
2 | 2 | - Use Conventional Commits for the PR title: `type(scope): description` |
3 | 3 | - 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 |
7 | 8 | - Breaking changes: append `!` after type/scope (`feat(api)!: ...`) or add a `BREAKING CHANGE:` footer |
8 | 9 | - If it's a work in progress, consider creating this PR as a draft. |
9 | 10 | - Don't hesistate to ask for opinion and review in the community chats, even if it's still a draft. |
|
0 commit comments