.github/PULL_REQUEST_TEMPLATE.md

   1 ## Motivation / Problem
   2
   3 <!--
   4 Describe here shortly
   5 * For bug fixes:
   6     * What problem does this solve?
   7     * If there is already an issue, link the issue, otherwise describe the problem here.
   8 * For features or gameplay changes:
   9     * What was the motivation to develop this feature?
  10     * Does this address any problem with the gameplay or interface?
  11     * Which group of players do you think would enjoy this feature?
  12 -->
  13
  14
  15 ## Description
  16
  17 <!--
  18 Describe here shortly
  19 * For bug fixes:
  20     * How is the problem solved?
  21 * For features or gameplay changes:
  22     * What does this feature do?
  23     * How does it improve/solve the situation described under 'motivation'.
  24 -->
  25
  26
  27 ## Limitations
  28
  29 <!--
  30 Describe here
  31 * Is the problem solved in all scenarios?
  32 * Is this feature complete? Are there things that could be added in the future?
  33 * Are there things that are intentionally left out?
  34 * Do you know of a bug or corner case that does not work?
  35 -->
  36
  37
  38 ## Checklist for review
  39
  40 Some things are not automated, and forgotten often. This list is a reminder for the reviewers.
  41 * The bug fix is important enough to be backported? (label: 'backport requested')
  42 * This PR affects the save game format? (label 'savegame upgrade')
  43 * This PR affects the GS/AI API? (label 'needs review: Script API')
  44     * ai_changelog.hpp, gs_changelog.hpp need updating.
  45     * The compatibility wrappers (compat_*.nut) need updating.
  46 * This PR affects the NewGRF API? (label 'needs review: NewGRF')
  47     * newgrf_debug_data.h may need updating.
  48     * [PR must be added to API tracker](https://wiki.openttd.org/en/Development/NewGRF/Specification%20Status)