]> git.smokeofanarchy.ru Git - space-station-14.git/commitdiff
Update PULL_REQUEST_TEMPLATE.md (#31046)
authorlzk <124214523+lzk228@users.noreply.github.com>
Sun, 8 Sep 2024 16:57:39 +0000 (18:57 +0200)
committerGitHub <noreply@github.com>
Sun, 8 Sep 2024 16:57:39 +0000 (18:57 +0200)
* Update PULL_REQUEST_TEMPLATE.md

* Update PULL_REQUEST_TEMPLATE.md 2

* Update PULL_REQUEST_TEMPLATE.md 3

* Update PULL_REQUEST_TEMPLATE.md 3

* Update PULL_REQUEST_TEMPLATE.md 5

* slart suggestions

Co-authored-by: slarticodefast <161409025+slarticodefast@users.noreply.github.com>
* paste

---------

Co-authored-by: slarticodefast <161409025+slarticodefast@users.noreply.github.com>
.github/PULL_REQUEST_TEMPLATE.md

index 7a8129df1a6686612fe5d41ba5fbf34f9f8c6e80..4029b093ccb4a80be9e211a2131d01cb6a39447a 100644 (file)
@@ -1,47 +1,33 @@
-<!-- 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. -->
+<!-- Guidelines: https://docs.spacestation14.io/en/getting-started/pr-guideline -->
 
 ## About the PR
-<!-- What did you change in this PR? -->
+<!-- What did you change? -->
 
 ## Why / Balance
-<!-- Why was it changed? Link any discussions or issues here. Please discuss how this would affect game balance. -->
+<!-- Discuss how this would affect game balance or explain why it was changed. Link any relevant discussions or issues. -->
 
 ## Technical details
-<!-- If this is a code change, summarize at high level how your new code works. This makes it easier to review. -->
+<!-- Summary of code changes for easier review. -->
 
 ## Media
-<!-- 
-PRs which make ingame changes (adding clothing, items, new features, etc) are required to have media attached that showcase the changes.
-Small fixes/refactors are exempt.
-Any media may be used in SS14 progress reports, with clear credit given.
-
-If you're unsure whether your PR will require media, ask a maintainer.
--->
+<!-- Attach media if the PR makes ingame changes (clothing, items, features, etc). 
+Small fixes/refactors are exempt. Media may be used in SS14 progress reports with credit. -->
 
 ## Requirements
-<!-- 
-Due to influx of PR's we require to ensure that PR's are following the correct guidelines.
-
-Please take a moment to read these if its your first time.
-
-Check the boxes below to confirm that you have in fact seen these (put an X in the brackets, like [X]):
--->
-- [ ] I have read and I am following the [Pull Request Guidelines](https://docs.spacestation14.com/en/general-development/codebase-info/pull-request-guidelines.html). I understand that not doing so may get my pr closed at maintainer’s discretion
-- [ ] I have added screenshots/videos to this PR showcasing its changes ingame, **or** this PR does not require an ingame showcase
+<!-- Confirm the following by placing an X in the brackets [X]: -->
+- [ ] I have read and am following the [Pull Request and Changelog Guidelines](https://docs.spacestation14.com/en/general-development/codebase-info/pull-request-guidelines.html).
+- [ ] I have added media to this PR or it does not require an ingame showcase.
+<!-- You should understand that not following the above may get your PR closed at maintainer’s discretion -->
 
 ## Breaking changes
-<!--
-List any breaking changes, including namespace, public class/method/field changes, prototype renames; and provide instructions for fixing them. This will be pasted in #codebase-changes.
--->
+<!-- List any breaking changes, including namespaces, public class/method/field changes, prototype renames; and provide instructions for fixing them.
+This will be posted in #codebase-changes. -->
 
 **Changelog**
+<!-- Add a Changelog entry to make players aware of new features or changes that could affect gameplay.
+Make sure to read the guidelines and take this Changelog template out of the comment block in order for it to show up.
+Changelog must have a :cl: symbol, so the bot recognizes the changes and adds them to the game's changelog. -->
 <!--
-Make players aware of new features and changes that could affect how they play the game by adding a Changelog entry. Please read the Changelog guidelines located at: https://docs.spacestation14.io/en/getting-started/pr-guideline#changelog
--->
-
-<!--
-Make sure to take this Changelog template out of the comment block in order for it to show up. Changelog must have a :cl: symbol, so the bot recognizes the changes and adds them to the game's changelog.
 :cl:
 - add: Added fun!
 - remove: Removed fun!