From 1b75bda180960e68e4f09eac628a98754985cd5a Mon Sep 17 00:00:00 2001 From: Nick Ruest Date: Tue, 28 Aug 2018 08:02:27 -0400 Subject: [PATCH] Add Pull Request template; resolves #35. (#38) --- .github/PULL_REQUEST_TEMPLATE.md | 42 ++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..8fb0e1a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,42 @@ +**The title of this pull-request should be a brief description of what the pull-request fixes/improves/changes. Ideally 50 characters or less.** + +* * * + +**GitHub issue(s)**: + +If you are responding to an issue, please mention their numbers below. + +* ex: #1 +* ex: #2 + +# What does this Pull Request do? + +A brief description of what the intended result of the Pull Request (PR) will be, what problem it solves, technical details, and any possible side effects. + +Example: +* Changes x feature to such that y +* Added x +* Removed y + +# How should this be tested? + +A description of what steps someone could take to: +* Reproduce the problem you are fixing (if applicable) +* Test that the PR does what is intended. +* Please be as detailed as possible. +* Good testing instructions help get your PR completed faster. + +# Additional Notes: + +Any additional information that you think would be helpful when reviewing this PR. + +Example: +* Does this change require documentation to be updated? +* Does this change add any new dependencies? +* Could this change or impact execution of existing code? + +# Interested parties + +Tag (@ mention) interested parties. + +Thanks in advance for your help with the Archives Unleashed Project!