From 762435cf0b13db55a5fd752ded4044a6ce2498d7 Mon Sep 17 00:00:00 2001 From: Nils Wentzell Date: Wed, 16 Oct 2019 10:01:16 -0400 Subject: [PATCH] Add github issue templates for bug and feature request --- .github/ISSUE_TEMPLATE/bug.md | 45 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature.md | 23 ++++++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 00000000..79dfa304 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,45 @@ +--- +name: Bug report +about: Create a report to help us improve +title: Bug report +labels: bug + +--- + +### Prerequisites + +* Please check that a similar issue isn't already filed: https://github.com/issues?q=is%3Aissue+user%3Atriqs + +### Description + +[Description of the issue] + +### Steps to Reproduce + +1. [First Step] +2. [Second Step] +3. [and so on...] + +or paste a minimal code example to reproduce the issue. + +**Expected behavior:** [What you expect to happen] + +**Actual behavior:** [What actually happens] + +### Versions + +Please provide the application version that you used. + +You can get this information from copy and pasting the output of +```bash +python -c "from app4triqs.version import *; show_version(); show_git_hash();" +``` +from the command line. Also, please include the OS you are running and its version. + +### Formatting + +Please use markdown in your issue message. A useful summary of commands can be found [here](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf). + +### Additional Information + +Any additional information, configuration or data that might be necessary to reproduce the issue. diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 00000000..0ca4d25b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: Feature request +labels: feature + +--- + +### Summary + +One paragraph explanation of the feature. + +### Motivation + +Why is this feature of general interest? + +### Implementation + +What user interface do you suggest? + +### Formatting + +Please use markdown in your issue message. A useful summary of commands can be found [here](https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf).