|
4 | 4 |
|
5 | 5 | <footer> |
6 | 6 |
|
7 | | -# Type should be one of the following: |
| 7 | +## Type should be one of the following: |
8 | 8 |
|
9 | 9 | - feat: a new feature |
10 | 10 | - fix: a bug fix |
|
16 | 16 | - build: changes that affect the build system or external dependencies |
17 | 17 | - ci: changes to our ci configuration files and scripts |
18 | 18 | - chore: other changes that don't modify src or test files |
19 | | -- revert: reverts a previous commit Scope is optional, but should be one of the |
20 | | - following: |
| 19 | +- revert: reverts a previous commit |
| 20 | + |
| 21 | +Use "<type>(<scope>)!" for breaking changes |
| 22 | + |
| 23 | +## Scope is optional, but should be one of the following: |
| 24 | + |
21 | 25 | - assets: changes to assets (images, fonts, etc.) |
22 | 26 | - audio: changes relating to sound or music |
23 | 27 | - core: changes to the core game functionality |
24 | 28 | - deps: changes to dependencies |
25 | 29 | - dev: changes to the development environment |
26 | 30 | - lint: changes that only affect linting such as auto-formatting |
27 | | -- mtx: changes to monetization or in-game purchases Subject line rules: |
| 31 | +- mtx: changes to monetization or in-game purchases |
| 32 | + |
| 33 | +## Subject line rules: |
| 34 | + |
28 | 35 | - Use imperative mood: "change" not "changed" nor "changes" |
29 | 36 | - No dot (.) at the end |
30 | 37 | - Limit to 72 characters |
31 | | -- No capitilization in the subject aside from issue references Body rules: |
| 38 | +- No capitilization in the subject aside from issue references |
| 39 | + |
| 40 | +## Body rules: |
| 41 | + |
32 | 42 | - Wrap at 72 characters |
33 | 43 | - Use imperative mood |
34 | 44 | - Explain what and why vs. how Footer rules: |
35 | 45 | - Reference issues and pull requests liberally |
36 | 46 | - Use "Fixes #123" or "Closes #123" for issues |
37 | | -- Use "BREAKING CHANGE:" for breaking changes |
|
0 commit comments