From 2fd79830bd6d7e046e7a713d2c5b98200fcf36ec Mon Sep 17 00:00:00 2001 From: Fei Gao Date: Mon, 4 Jun 2018 14:25:41 -0400 Subject: [PATCH] Update issue templates (#707) * Update issue templates * PR template * Update PULL_REQUEST_TEMPLATE.md * Update issue-making.md --- .github/ISSUE_TEMPLATE/issue-making.md | 17 +++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 3 +++ 2 files changed, 20 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/issue-making.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/issue-making.md b/.github/ISSUE_TEMPLATE/issue-making.md new file mode 100644 index 00000000..3f607528 --- /dev/null +++ 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 new file mode 100644 index 00000000..a1aeffa8 --- /dev/null +++ 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 pax 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.