tommy/tbd-station-14
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reword the PR template to be more concise (#13420)

Browse Source
This commit is contained in:
DrSmugleaf
2023-01-12 07:48:19 +01:00
committed by GitHub
parent 3e699a680f
commit 098074fb61
1 changed files with 16 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -1,39 +1,39 @@
<!-- The text between the arrows are comments - they will not be visible on your PR. -->
<!-- Please read these guidelines before opening your PR: https://docs.spacestation14.io/en/getting-started/pr-guideline --> <!-- Please read these guidelines before opening your PR: https://docs.spacestation14.io/en/getting-started/pr-guideline -->
<!-- The text between the arrows are comments - they will not be visible on your PR. -->
## About the PR
<!-- What does it change? What other things could this impact? -->
## About the PR <!-- Describe the Pull Request here. What does it change? What other things could this impact? -->
**Media** **Media**
<!-- <!--
If applicable, add screenshots or videos to showcase your PR. Small fixes/refactors are exempt, but all PRs which make ingame changes PRs which make ingame changes (adding clothing, items, new features, etc) are required to have media attached that showcase the changes.
(adding clothing, items, new features, etc) must include ingame media or the PR will not be merged, in accordance with our PR guidelines. Small fixes/refactors are exempt.
This makes it much easier for us to merge PRs and find media for progress reports. If you include media in your pull request, we Any media may be used in SS14 progress reports, with clear credit given.
may potentially use it in the SS14 progress reports, with clear credit given.
Use screenshot software like Window's built in snipping tool, ShareX, Lightshot, or recording software like ShareX (gif), ScreenToGif, or Open Broadcaster Software (cross platform).
If you're unsure whether your PR will require media, ask a maintainer. If you're unsure whether your PR will require media, ask a maintainer.
Check one of the boxes below to confirm that you have in fact seen this (put an X in the brackets, like [X]): Check the box below to confirm that you have in fact seen this (put an X in the brackets, like [X]):
--> -->
- [ ] I have added screenshots/videos to this PR showcasing its changes ingame, **or** this PR does not require an ingame showcase - [ ] I have added screenshots/videos to this PR showcasing its changes ingame, **or** this PR does not require an ingame showcase
**Changelog** **Changelog**
<!-- <!--
Here you can fill out a changelog that will automatically be added to the game when your PR is merged Here you can fill out a changelog that will automatically be added to the game when your PR is merged.
There are 4 icons for changelog entries: add, remove, tweak, fix. I trust you can figure out the rest.
You can put your name after the :cl: symbol to change the name that shows in the changelog (otherwise it takes your GitHub username) Only put changes that are visible and important to the player on the changelog.
Like so: :cl: PJB
Generally, only put things in changelogs that players actually care about. Stuff like "Refactored X system, no changes should be visible" shouldn't be on a changelog. Don't consider the entry type suffix (e.g. add) to be "part" of the sentence:
For writing actual entries, don't consider the entry type suffix (e.g. add) to be "part" of the sentence:
bad: - add: a new tool for engineers bad: - add: a new tool for engineers
good: - add: added a new tool for engineers good: - add: added a new tool for engineers
Putting a name after the :cl: symbol will change the name that shows in the changelog (otherwise it takes your GitHub username)
Like so: :cl: PJB
--> -->
:cl: :cl:
- add: Added fun! - add: Added fun!
- remove: Removed fun! - remove: Removed fun!
- tweak: Changed fun!
- fix: Fixed fun!