diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 98fe22ab33..42203e2250 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,13 +1,19 @@ -[Release Notes]: # (Your PR should contain a detailed list of notable changes, titled appropriately. This includes any observable changes to the server or DMAPI. See example below) +[Release Notes]: # (Your PR should contain a detailed list of notable changes, titled appropriately. This includes any observable changes to the server or DMAPI. See examples below) :cl: -Description of your change -Each newline corresponds to a release note in the upcoming sprint +Description of your change. +Each newline corresponds to a release note in the release your change is included in. /:cl: :cl: -You can also have multiple sets of release notes per pull request -They will be amalgamated together in the end +You can also have multiple sets of release notes per pull request. +They will be amalgamated together in the end. /:cl: -[Why]: # (Please add a short description [two lines down] of why you think these changes would benefit the game. If you can't justify it in words, it might not be worth adding.) +:cl: Categories +Categories are divided up in the release notes and set after the :cl: header. +The default category is Core. +The current standard categories are Core, DMAPI, HTTP API, and Host Watchdog. +/:cl: + +[Why]: # (If this does not close or work on an existing GitHub issue, please add a short description [two lines down] of why you think these changes would benefit the server. If you can't justify it in words, it might not be worth adding.)