From 70edcb2a3d820f08d17c5e053443255f3cc656a1 Mon Sep 17 00:00:00 2001 From: Daniel Gibbs Date: Sun, 7 Apr 2019 17:49:53 +0100 Subject: [PATCH] feat(docs): PR will now request GitHub email for co-author --- PULL_REQUEST_TEMPLATE.md | 43 ++++++++++++++++++++++++++++------------ 1 file changed, 30 insertions(+), 13 deletions(-) diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index d04485f45..f139c2cc0 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -2,22 +2,39 @@ Please include a summary of the change and which issue is fixed. -Fixes #\[issue] +Fixes #[issue] ## Type of change -* [ ] Bug fix (change which fixes an issue) -* [ ] New feature (change which adds functionality) -* [ ] New Server (new server added) -* [ ] Refactor (restructures existing code) -* [ ] Comment update (typo, spelling, etc) +* [ ] Bug fix (change which fixes an issue). +* [ ] New feature (change which adds functionality). +* [ ] New Server (new server added). +* [ ] Refactor (restructures existing code). +* [ ] Comment update (typo, spelling, etc). +* [ ] This change requires a documentation update. ## Checklist -* [ ] My code follows the style guidelines of this project -* [ ] This pull request links to an issue -* [ ] This pull request uses the `develop` branch as its base -* [ ] 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 +* [ ] This code follows the style guidelines of this project. +* [ ] This pull request links to an issue. +* [ ] This pull request uses the `develop` branch as its base. +* [ ] 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. + +## Provide Github Email + +Fill out below info or tick box below: +``` +Co-authored-by: John Doe +``` + +- [ ] 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).