From 24f480c9c40a94037ee65e23e7fb828e893e19cb Mon Sep 17 00:00:00 2001 From: Pieter-Jan Briers Date: Wed, 10 Mar 2021 11:48:01 +0100 Subject: [PATCH] Elaborate on wording of changelog entries --- .github/PULL_REQUEST_TEMPLATE.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 6b9ac0b2a0..552e8babc5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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 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: