Browse Source

refactor of pull request template

pull/2399/head
Daniel Gibbs 6 years ago
parent
commit
62cb12f6f6
  1. 22
      .github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md

22
PULL_REQUEST_TEMPLATE.md → .github/ISSUE_TEMPLATE/PULL_REQUEST_TEMPLATE.md

@ -1,6 +1,6 @@
# Description
Please include a summary of the change and which issue is fixed.
Please include a summary of the change and which issues is fixed
Fixes #[issue]
@ -11,18 +11,19 @@ Fixes #[issue]
* [ ] New Server (new server added).
* [ ] Refactor (restructures existing code).
* [ ] Comment update (typo, spelling, explanation, examples, etc).
* [ ] This change requires a documentation update.
## Checklist
* [ ] This code follows the style guidelines of this project.
PR will not be merged until all steps are complete.
* [ ] This pull request links to an issue.
* [ ] This pull request uses the `develop` branch as its base.
* [ ] This code follows the style guidelines of this project.
* [ ] I have provided Co-author details below.
* [ ] I have performed a self-review of my own code.
* [ ] I have squashed commits.
* [ ] I have commented my code, particularly in hard to understand areas.
* [ ] I have made corresponding changes to the documentation if required.
* [ ] I have checked that this code is commented where required.
* [ ] I have provided a detailed enough description of this PR.
* [ ] I have checked If documentation needs updating.
## Provide Github Email
@ -33,8 +34,15 @@ Co-authored-by: John Doe <[email protected]>
- [ ] I do not wish to provide an email. I am aware this will hide me as the author of this commit.
All pull requests will now be squashed to create a tidy commit history and simplify changelog creation. You can provide either your own email or a GitHub-provided no-reply email.
When a PR is squashed the author becomes the person who squashed the PR. This removes you as the author of your own PR.
The only workaround for this is to add your details as a co-author. More info about co-authors can be found [here](https://help.github.com/en/articles/creating-a-commit-with-multiple-authors).
## 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!**
Loading…
Cancel
Save