Add GitHub template for issues and PRs

yan-foto · Dec 6, 2018 · 6ad1a18 · 6ad1a18
1 parent abb9e27
commit 6ad1a18
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1 +1,3 @@
 .travis.yml
+ISSUE_TEMPLATE.md
+PULL_REQUEST_TEMPLATE.md
diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md
@@ -0,0 +1,10 @@
+**NOTE**: before openning an issue, please consult previous issues (both open and closed).
+
+## What is the problem
+Concisely describe the problem.
+
+## How to reproduce
+Describe in short how to reproduce the problem.
+
+## Additional information
+Any other information that might be helpful (e.g., OS, node/electron version)
diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,4 @@
+# A quick note for PRs
+  * PRs are strictly limited to technical changes to the source code (e.g., please no PRs for changes to the documentation)
+  * Before submitting a PR, please consult the issues, if you don't find a matching issue, open a new one and let's discuss the changes first
+  * *Always* refer to the corresponding issue addressed by your PR in the last commit (e.g., `fixes #12`)