Explorar o código

chore: add updated PR template to master

Daniel Gibbs hai 2 días
pai
achega
db1a751e95
Modificáronse 1 ficheiros con 11 adicións e 13 borrados
  1. 11 13
      .github/pull_request_template.md

+ 11 - 13
.github/pull_request_template.md

@@ -1,20 +1,23 @@
 # Description
 
-Please include a summary of the change and which issues are fixed.
+<!-- Summarise the change and why it is needed. -->
 
 Fixes #[issue]
 
+Affected servers: <!-- shortnames, e.g. ck, rust, or "all" -->
+
 ## Type of change
 
 - [ ] Bug fix (a change which fixes an issue).
 - [ ] New feature (a change which adds functionality).
 - [ ] New Server (new server added).
 - [ ] Refactor (restructures existing code).
+- [ ] Chore (CI, workflows, tooling or other maintenance).
 - [ ] Comment update (typo, spelling, explanation, examples, etc).
 
 ## Testing
 
-Please list the exact validation you performed and the outcome.
+<!-- List the exact validation you performed and the outcome. -->
 
 - Commands/tests run:
 - Result:
@@ -30,28 +33,23 @@ Please list the exact validation you performed and the outcome.
 - [ ] No breaking changes.
 - [ ] Breaking changes included (describe below).
 
-## Documentation impact
+## Documentation
+
+<!-- If documentation needs updating, open a PR on the docs repo (preferred) or request an update. -->
 
 - [ ] No documentation update required.
-- [ ] User documentation update required.
-- [ ] Developer documentation update required.
+- [ ] User documentation update required ([LinuxGSM-Docs](https://github.com/GameServerManagers/LinuxGSM-Docs)).
+- [ ] Developer documentation update required ([LinuxGSM-Dev-Docs](https://github.com/GameServerManagers/LinuxGSM-Dev-Docs)).
 
 ## Checklist
 
 PR will not be merged until all steps are complete.
 
-- [ ] This pull request links to an issue.
+- [ ] This pull request links to an issue ("Fixes", or "Related to" for a partial fix).
 - [ ] This pull request uses the develop branch as its base.
 - [ ] This pull request subject follows the Conventional Commits standard.
 - [ ] This code follows the style guidelines of this project.
 - [ ] I have performed a self-review of my code.
 - [ ] I have provided a detailed enough description of this PR.
 
-## Documentation
-
-If documentation does need updating either update it by creating a PR (preferred) or request a documentation update.
-
-- User docs: <https://github.com/GameServerManagers/LinuxGSM-Docs>
-- Dev docs: <https://github.com/GameServerManagers/LinuxGSM-Dev-Docs>
-
 **Thank you for your Pull Request!**