Make things easier to remind. Same rule for commit and PR.
This commit is contained in:
parent
c476858880
commit
fd1b644490
@ -42,28 +42,19 @@ Please don't edit the ChangeLog file. A project manager will update it from your
|
|||||||
Use clear commit messages with the following structure:
|
Use clear commit messages with the following structure:
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
KEYWORD Short description (may be the bug number #456)
|
FIXED|Fixed #456 Short description (where #456 is number of bug fix, if it exists. In upper case to appear into ChangeLog)
|
||||||
|
or
|
||||||
|
CLOSED|Closed #456 Short description (where #456 is number feature request, if it exists. In upper case to appear into ChangeLog)
|
||||||
|
or
|
||||||
|
NEW|New Short description (In upper case to appear into ChangeLog)
|
||||||
|
or
|
||||||
|
Short description (when the commit is not introducing feature or closing a bug)
|
||||||
|
|
||||||
Long description (Can span accross multiple lines).
|
Long description (Can span accross multiple lines).
|
||||||
</pre>
|
</pre>
|
||||||
|
|
||||||
Where KEYWORD is one of:
|
|
||||||
|
|
||||||
- "Fixed" for bug fixes (May be followed by the bug number i.e: #456)
|
|
||||||
- "Closed" for a commit to close a feature request issue (May be followed by the bug number i.e: #456)
|
|
||||||
- void, don't put a keyword if the commit is not introducing feature or closing a bug.
|
|
||||||
|
|
||||||
### Pull Requests
|
### Pull Requests
|
||||||
When submitting a pull request, use following syntax:
|
When submitting a pull request, use same rule than Commits. With upper case keyword to appear into ChangeLog.
|
||||||
|
|
||||||
<pre>
|
|
||||||
KEYWORD Short description (may be the bug number #456)
|
|
||||||
</pre>
|
|
||||||
|
|
||||||
Where KEYWORD is one of:
|
|
||||||
|
|
||||||
- "FIXED" or "Fixed" for bug fixes. In upper case to appear into ChangeLog. (May be followed by the bug number i.e: #456)
|
|
||||||
- "NEW" or "New" for new features. In upper case to appear into ChangeLog. (May be followed by the task number i.e: #123)
|
|
||||||
|
|
||||||
|
|
||||||
### Resources
|
### Resources
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user