Skip to content

Commit

Permalink
Update issue templates (#707)
Browse files Browse the repository at this point in the history
* Update issue templates

* PR template

* Update PULL_REQUEST_TEMPLATE.md

* Update issue-making.md
  • Loading branch information
feigaodm authored Jun 4, 2018
1 parent e9c0cbe commit 2fd7983
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/issue-making.md
Original file line number Diff line number Diff line change
@@ -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
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 2fd7983

Please sign in to comment.