Skip to content

Commit b35dd54

Browse files
committed
docs: Introduce conventional commits to CONTRIBUTING.md (#1361)
1 parent f9913a5 commit b35dd54

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

CONTRIBUTING.md

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ The `TheSuperHackers` word and `@keyword` are mandatory. `author` and date can b
6060
|------------------|-------------------------------------------------------------|
6161
| @bugfix | Fixes a bug |
6262
| @fix | Fixes something, but is not a user facing bug |
63-
| @compile | Addresses a compile warning or error |
63+
| @build | Addresses a compile warning or error |
6464
| @feature | Adds something new |
6565
| @performance | Improves performance |
6666
| @refactor | Moves or rewrites code, but does not change the behaviour |
@@ -83,27 +83,37 @@ Optionally, the pull request number can be appended to the comment. This can onl
8383

8484
### Pull request documentation
8585

86-
The title of a new Pull Request, and/or commit(s) within, begin with a **[GEN]** and/or **[ZH]** tag, depending on the game(s) it targets. If a change does not target a game, then a tag is not necessary. Furthermore, the title consists of a concise and descriptive sentence about the change and/or commit, beginning with an uppercase letter and ending without a dot. The title ideally begins with a word that describes the action that the change takes, for example `Fix *this*`, `Change *that*`, `Add *those*`, `Refactor *thing*`.
86+
The title of a new Pull Request, and/or commit(s) within, begins with a [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) tag. The tag is followed by a concise and descriptive sentence about the change and/or commit, beginning with an upper case letter and ending without a dot. The sentence ideally begins with a word that describes the action that the change takes, for example `fix *this*`, `change *that*`, `add *those*`, `refactor *thing*`.
87+
88+
Allowed (extended) commit title types are:
89+
```
90+
bugfix:
91+
build:
92+
chore:
93+
ci:
94+
docs:
95+
fix:
96+
feat:
97+
perf:
98+
refactor:
99+
style:
100+
test:
101+
tweak:
102+
unify:
103+
```
104+
105+
For the optional scope behind the type pick a suitable word that describes the overall area that the change touches.
87106

88107
Good:
89108
```
90-
[GEN][ZH] Fix uninitialized memory access in Get_OS_Info
109+
bugfix(system): fix uninitialized memory access in Get_OS_Info
91110
```
92111

93112
Bad:
94113
```
95114
Minimal changes for successful build.
96115
```
97116

98-
Currently established commit title tags are
99-
100-
* [GEN]
101-
* [ZH]
102-
* [CORE]
103-
* [CMAKE]
104-
* [GITHUB]
105-
* [LINUX]
106-
107117
If the Pull Request is meant to be merged with rebase, then a note for **Merge with Rebase** should be added to the top of the text body, to help identify the correct merge action when it is ready for merge. All commits of the Pull Request need to be properly named and need the number of the Pull Request added as a suffix in parentheses. Example: **(#333)**. All commits need to be able to compile on their own without dependencies in newer commits of the same Pull Request. Prefer to create changes for **Squash and Merge**, as this will simplify things.
108118

109119
The text body begins with links to related issue report(s) and/or Pull Request(s) if applicable.

0 commit comments

Comments
 (0)