diff options
author | frosch <frosch@openttd.org> | 2020-12-22 22:39:24 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-12-22 22:39:24 +0100 |
commit | 3f606691a8f94e7626327ccd6b7293b3d39da743 (patch) | |
tree | 49984ae36e840994742e3184571b23961fb49bd1 /.github | |
parent | cc8301449e4426dbd42622317ca772766a8386f7 (diff) | |
download | openttd-3f606691a8f94e7626327ccd6b7293b3d39da743.tar.xz |
Add: [GitHub] PR template. (#8414)
Diffstat (limited to '.github')
-rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..1949f6f1f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,47 @@ +## Motivation / Problem + +<!-- +Describe here shortly +* For bug fixes: + * What problem does this solve? + * If there is already an issue, link the issue, otherwise describe the problem here. +* For features or gameplay changes: + * What was the motivation to develop this feature? + * Does this address any problem with the gameplay or interface? + * Which group of players do you think would enjoy this feature? +--> + + +## Description + +<!-- +Describe here shortly +* For bug fixes: + * How is the problem solved? +* For features or gameplay changes: + * What does this feature do? + * How does it improve/solve the situation described under 'motivation'. +--> + + +## Limitations + +<!-- +Describe here +* Is the problem solved in all scenarios? +* Is this feature complete? Are there things that could be added in the future? +* Are there things that are intentionally left out? +* Do you know of a bug or corner case that does not work? +--> + + +## Checklist for review + +Some things are not automated, and forgotten often. This list is a reminder for the reviewers. +* The bug fix is important enough to be backported? (label: 'backport requested') +* This PR affects the save game format? (label 'savegame upgrade') +* This PR affects the GS/AI API? (label 'needs review: Script API') + * ai_changelog.hpp, gs_changelog.hpp need updating. + * The compatibility wrappers (compat_*.nut) need updating. +* This PR affects the NewGRF API? (label 'needs review: NewGRF') + * [PR must be added to API tracker](https://wiki.openttd.org/en/Development/NewGRF/Specification%20Status) |