Elaborate on wording of changelog entries
This commit is contained in:
committed by
GitHub
parent
20618eba2c
commit
24f480c9c4
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
4
.github/PULL_REQUEST_TEMPLATE.md
vendored
@@ -16,6 +16,10 @@ You can put your name after the :cl: symbol to change the name that shows in the
|
|||||||
Like so: :cl: PJB
|
Like so: :cl: PJB
|
||||||
|
|
||||||
Generally, only put things in changelogs that players actually care about. Stuff like "Refactored X system, no changes should be visible" shouldn't be on a changelog.
|
Generally, only put things in changelogs that players actually care about. Stuff like "Refactored X system, no changes should be visible" shouldn't be on a changelog.
|
||||||
|
|
||||||
|
For writing actual entries, don't consider the entry type suffix (e.g. add) to be "part" of the sentence:
|
||||||
|
bad: - add: a new tool for engineers
|
||||||
|
good: - add: added a new tool for engineers
|
||||||
-->
|
-->
|
||||||
|
|
||||||
:cl:
|
:cl:
|
||||||
|
|||||||
Reference in New Issue
Block a user