Make the issue and PR templates. (#231)

XENON1T · Jun 4, 2018 · 0dfb1b5 · 0dfb1b5
1 parent 49480d7
commit 0dfb1b5
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE/issue-making.md b/.github/ISSUE_TEMPLATE/issue-making.md
@@ -0,0 +1,17 @@
+---
+name: Issue making
+about: Please read before creating an issue
+
+---
+
+Before you start an issue, please note that this repository is public.  Therefore:
+
+1) Only the technical details of the code can be mentioned directly on GitHub.
+2) If the analysis details are necessary for the Issue, please make a wiki note and link it.
+
+Beyond this, please make sure that you elaborate on:
+
+*  The full error (use gist.github.com)
+*  How you created the error
+*  The minimal example to reproduce the error (if applicable)
+*  Where you are running your code
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,3 @@
+# Please read before creating a Pull Request
+
+Before you start a pull request (PR), please note that hax is public. Only the technical details of the code can be mentioned directly on GitHub.  If the analysis details are necessary for the PR, please make a wiki note and link it.  The pull request will focus on the technical aspects rather than the motivation for the feature request.