-
Notifications
You must be signed in to change notification settings - Fork 4.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Make the pull request template easier to use
This commit changes the Github pull request template to: - Remove superfluous Markdown formatting in comment blocks - Move URLs to separate lines to facilitate copy/paste - Clean up the Summary instructions and try to explain better - Simplify the Purpose section with less emphasis on issue links - Describe alternatives in alternative ways
- Loading branch information
1 parent
6c4120d
commit bc87b3d
Showing
1 changed file
with
34 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,62 +1,54 @@ | ||
| <!-- | ||
| ### How to use | ||
| Leave the headings unless they don't apply to your PR, replace commented out text (surrounded with <!–– and ––>) with text describing your PR. | ||
| NOTE: Please grant permission for repository maintainers to edit your PR. | ||
| It is EXTREMELY common for PRs to be held up due to trivial changes being requested and the author being unavailable to make them. | ||
| <!-- HOW TO USE: Under each "#### Heading" below, enter information relevant to your pull request. | ||
| Leave the headings unless they don't apply to your PR, and remove the comment blocks (surrounded with <!–– and ––>) when you are done. | ||
| NOTE: Please grant permission for repository maintainers to edit your PR. It is EXTREMELY common for PRs to be held up due to trivial changes being requested and the author being unavailable to make them. | ||
| --> | ||
|
|
||
| #### Summary | ||
| <!-- | ||
| A one-line description of your change that will be extracted and added to the [project changelog](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/data/changelog.txt). | ||
|
|
||
| The format is (ignore the square brackets): ```SUMMARY: [Category] "[description]"``` | ||
| <!-- This section should consist of exactly one line, formatted like this: | ||
| SUMMARY: [Category] "[Briefly describe the change in these quotation marks]" | ||
| The categories to choose from are: | ||
| Do not enter the square brackets []. Category must be one of these: | ||
| * Features | ||
| * Content | ||
| * Interface | ||
| * Mods | ||
| * Balance | ||
| * Bugfixes | ||
| * Performance | ||
| * Infrastructure | ||
| * Build | ||
| * I18N | ||
| - Features | ||
| - Content | ||
| - Interface | ||
| - Mods | ||
| - Balance | ||
| - Bugfixes | ||
| - Performance | ||
| - Infrastructure | ||
| - Build | ||
| - I18N | ||
| Example: ```SUMMARY: Content "Adds new mutation category 'Mouse'"``` | ||
| For more on the meaning of each category, see: | ||
| https://github.com/CleverRaven/Cataclysm-DDA/blob/master/doc/CHANGELOG_GUIDELINES.md | ||
| See the [Changelog Guidelines](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/doc/CHANGELOG_GUIDELINES.md) for explanations of the categories. | ||
| If approved and merged, your summary will be added to the project changelog: | ||
| https://github.com/CleverRaven/Cataclysm-DDA/blob/master/data/changelog.txt | ||
| --> | ||
|
|
||
| #### Purpose of change | ||
| <!-- | ||
| If there's an existing issue describing the problem this PR addresses or the feature it adds, please link it like: ```#1234``` | ||
| If it *fully* resolves an issue, link it like: Fixes #1234 | ||
| Even if the issue describes the problem, please provide a few-sentence summary here. | ||
| Example: Fixes #1234 - XL mutants cannot wear arm/leg splints due to missing OVERSIZE flag. | ||
| If there is no related issue, please describe the issue you are addressing, including how to trigger a bug if this is a bugfix. | ||
| Don't put the backticks around the `#` and issue or pull request number to allow the GitHub automatically reference to it. | ||
|
|
||
| <!-- With a few sentences, describe your reasons for making this change. If it relates to an existing issue, you can link it with a # followed by the Github issue number, like #1234. If your pull request *fully* resolves an issue, include the word "Fix" or "Fixes" before the issue number, like: Fixes #1234. | ||
| If there is no related issue, explain here what issue, feature, or other concern you are addressing. If this is a bugfix, include steps to reproduce the original bug, so your fix can be verified. | ||
| --> | ||
|
|
||
| #### Describe the solution | ||
| <!-- | ||
| How does the feature work, or how does this fix a bug? | ||
| The easier you make your solution to understand, the faster it can get merged. | ||
| --> | ||
|
|
||
| <!-- How does the feature work, or how does this fix a bug? The easier you make your solution to understand, the faster it can get merged. --> | ||
|
|
||
| #### Describe alternatives you've considered | ||
| <!-- | ||
| A clear and concise description of any alternative solutions or features you've considered. | ||
| --> | ||
|
|
||
| <!-- Explain any alternative solutions, different approaches, or possibilities you've considered using to solve the same problem. --> | ||
|
|
||
| #### Testing | ||
| <!-- | ||
| Describe what steps you took to test that this PR resolved the bug or added the feature, and what tests you performed to make sure it didn't cause any regressions. | ||
| Also include testing suggestions for reviewers and maintainers. | ||
| --> | ||
|
|
||
| <!-- Describe what steps you took to test that this PR resolved the bug or added the feature, and what tests you performed to make sure it didn't cause any regressions. Also include testing suggestions for reviewers and maintainers. --> | ||
|
|
||
| #### Additional context | ||
| <!-- | ||
| Add any other context (such as mock-ups, proof of concepts or screenshots) about the feature or bugfix here. | ||
| --> | ||
|
|
||
| <!-- Add any other context (such as mock-ups, proof of concepts or screenshots) about the feature or bugfix here. --> |