Add PR templates

wil3 · Jun 6, 2020 · 023b9af · 023b9af
1 parent 3d8b91c
commit 023b9af
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/.github/PULL_REQUEST_TEMPLATE/bug_fix.md
@@ -0,0 +1,14 @@
+### Requirements for Contributing a Bug Fix
+* Read
+  [CONTRIBUTING.md](https://github.com/wil3/gymfc/blob/master/CONTRIBUTING.md)
+* The pull request must only fix an existing bug. To contribute other changes, you must use a different template.
+* Open an issue. Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.
+* Fill out the template below, any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
+
+### Identify the Bug
+
+Closes: #XXX
+
+### Description of the Change
+
+### Verification and Validation of the Change
diff --git a/.github/PULL_REQUEST_TEMPLATE/feature_change.md b/.github/PULL_REQUEST_TEMPLATE/feature_change.md
@@ -0,0 +1,29 @@
+### Requirements for Adding, Changing, or Removing a Feature
+* Read
+  [CONTRIBUTING.md](https://github.com/wil3/gymfc/blob/master/CONTRIBUTING.md)
+* Open an issue. Any change needs to be discussed before proceeding. Failure to do so may result in the rejection of the pull request.
+* Fill out the template below, any pull request that does not include enough information to be reviewed in a timely manner may be closed at the maintainers' discretion.
+
+### Description of the Change
+
+Closes: #XXX
+
+<!--
+
+We must be able to understand the design of your change from this description. If we can't get a good idea of what the code will be doing from the description here, the pull request may be closed at the maintainers' discretion. Keep in mind that the maintainer reviewing this PR may not be familiar with or have worked with the code here recently, so please walk us through the concepts.
+
+-->
+
+### Verification Process
+
+<!--
+
+What process did you follow to verify that your change has the desired effects?
+
+- How did you verify that all new functionality works as expected?
+- How did you verify that all changed functionality works as expected?
+- How did you verify that the change has not introduced any regressions?
+
+Describe the actions you performed (commands you ran, etc.), and describe the results you observed.
+
+-->