Skip to content

Commit 4f78079

Browse files
docs: update commit instructions for clarity and formatting
1 parent 13e6956 commit 4f78079

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

.github/commit-instructions.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<footer>
66

7-
# Type should be one of the following:
7+
## Type should be one of the following:
88

99
- feat: a new feature
1010
- fix: a bug fix
@@ -16,22 +16,31 @@
1616
- build: changes that affect the build system or external dependencies
1717
- ci: changes to our ci configuration files and scripts
1818
- 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+
2125
- assets: changes to assets (images, fonts, etc.)
2226
- audio: changes relating to sound or music
2327
- core: changes to the core game functionality
2428
- deps: changes to dependencies
2529
- dev: changes to the development environment
2630
- 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+
2835
- Use imperative mood: "change" not "changed" nor "changes"
2936
- No dot (.) at the end
3037
- 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+
3242
- Wrap at 72 characters
3343
- Use imperative mood
3444
- Explain what and why vs. how Footer rules:
3545
- Reference issues and pull requests liberally
3646
- Use "Fixes #123" or "Closes #123" for issues
37-
- Use "BREAKING CHANGE:" for breaking changes

0 commit comments

Comments
 (0)