You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|@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 |
64
64
|@feature| Adds something new |
65
65
|@performance| Improves performance |
66
66
|@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
83
83
84
84
### Pull request documentation
85
85
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.
87
106
88
107
Good:
89
108
```
90
-
[GEN][ZH] Fix uninitialized memory access in Get_OS_Info
109
+
bugfix(system): fix uninitialized memory access in Get_OS_Info
91
110
```
92
111
93
112
Bad:
94
113
```
95
114
Minimal changes for successful build.
96
115
```
97
116
98
-
Currently established commit title tags are
99
-
100
-
*[GEN]
101
-
*[ZH]
102
-
*[CORE]
103
-
*[CMAKE]
104
-
*[GITHUB]
105
-
*[LINUX]
106
-
107
117
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.
108
118
109
119
The text body begins with links to related issue report(s) and/or Pull Request(s) if applicable.
0 commit comments