From cd3bf209bfa6069ca081a2510f835c96e2adb478 Mon Sep 17 00:00:00 2001 From: Yinlin Chen <ylchen@vt.edu> Date: Tue, 24 Jul 2018 10:56:29 -0400 Subject: [PATCH] Add PR template --- .github/PULL_REQUEST_TEMPLATE.md | 38 ++++++++++++++++++++++++++++++++ 1 file changed, 38 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 00000000..e64b4bb9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,38 @@ +**The title of this pull-request should be a brief description of what the pull-request fixes/improves/changes. Ideally 50 characters or less.** +* * * + +**JIRA Ticket**: (link) (:star:) + +* Other Relevant Links (Meeting note, project page, related pull requests, etc.) + +# What does this Pull Request do? (:star:) +A brief description of what the intended result of the PR will be and/or what problem it solves. + +# What's the changes? (:star:) +A in-depth description of the changes made by this PR. Technical details and possible side effects. + +Example: +* Changes x feature to such that y +* Added new feature x +* Removed y to fix z + +# How should this be tested? + +A description of what steps someone could take to: +* Outline the steps to test or reproduce the PR here. +* Please be as detailed as possible. + +# Additional Notes: +Any additional information that you think would be helpful when reviewing this PR. + +Example: +* What branch to be used for testing this PR? +* Does this change require documentation to be updated? +* Does this change add any new dependencies? +* Does this change require any other modifications to be made to the repository? +* Could this change impact execution of existing code? + +# Interested parties +Tag (@ mention) interested parties + +(:star:) Required fields -- GitLab