Create PULL_REQUEST_TEMPLATE.md

freetzing · Mar 5, 2018 · 8eca140 · 8eca140
1 parent e26a3ce
commit 8eca140
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,30 @@
+# PR Title
+
+### Context:
+Describe the code changes of this Pull Request.
+
+### Branch Names:
+
+Pick one of the following branch name for your commits:
+- `feature-*` A new feature was added to the codebase
+- `fix-*` A bug was fixed
+- `refactor-*` The code were refactored
+- `cleanup-*` The code were refactored
+
+```
+git checkout -b feature-your-branch
+```
+
+### Proposed Changes
+
+- [ ] implement feature
+- [ ] document feature
+- [ ] test feature
+- [ ] update version at the `Makefile`
+- [ ] `make` this will build the new source and generate the new docs
+- [ ] `make build-commit` if everything pass, we can build and `git commit` the artifact
+
+The following command need to be exit with code `0` to be merged!
+```
+make
+```