.github/PULL_REQUEST_TEMPLATE.md

   1 <!--
   2 Commit message:
   3
   4 - Please use Feature / Add / Change / Fix for player-facing changes. E.g.: "Feature: My cool new feature".
   5 - Please use Feature / Add / Change / Fix followed by "[NewGRF]" or "[Script]" for moddable changes. E.g.: "Feature: [NewGRF] My cool new NewGRF addition".
   6 - Please use Codechange / Codefix for developer-facing changes. E.g.: "Codefix #1234: Validate against nullptr properly".
   7
   8 See https://github.com/OpenTTD/OpenTTD/blob/master/CODINGSTYLE.md#commit-message for more details.
   9 -->
  10
  11 ## Motivation / Problem
  12
  13 <!--
  14 Describe here shortly
  15 * For bug fixes:
  16     * What problem does this solve?
  17     * If there is already an issue, link the issue, otherwise describe the problem here.
  18 * For features or gameplay changes:
  19     * What was the motivation to develop this feature?
  20     * Does this address any problem with the gameplay or interface?
  21     * Which group of players do you think would enjoy this feature?
  22 -->
  23
  24
  25 ## Description
  26
  27 <!--
  28 Describe here shortly
  29 * For bug fixes:
  30     * How is the problem solved?
  31 * For features or gameplay changes:
  32     * What does this feature do?
  33     * How does it improve/solve the situation described under 'motivation'.
  34 -->
  35
  36
  37 ## Limitations
  38
  39 <!--
  40 Describe here
  41 * Is the problem solved in all scenarios?
  42 * Is this feature complete? Are there things that could be added in the future?
  43 * Are there things that are intentionally left out?
  44 * Do you know of a bug or corner case that does not work?
  45 -->
  46
  47
  48 ## Checklist for review
  49
  50 Some things are not automated, and forgotten often. This list is a reminder for the reviewers.
  51 * The bug fix is important enough to be backported? (label: 'backport requested')
  52 * This PR touches english.txt or translations? Check the [guidelines](https://github.com/OpenTTD/OpenTTD/blob/master/docs/eints.md)
  53 * This PR affects the save game format? (label 'savegame upgrade')
  54 * This PR affects the GS/AI API? (label 'needs review: Script API')
  55     * ai_changelog.hpp, game_changelog.hpp need updating.
  56     * The compatibility wrappers (compat_*.nut) need updating.
  57 * This PR affects the NewGRF API? (label 'needs review: NewGRF')
  58     * newgrf_debug_data.h may need updating.
  59     * [PR must be added to API tracker](https://wiki.openttd.org/en/Development/NewGRF/Specification%20Status)