LCPQ/dft_tools
3
0
Fork 0
mirror of https://github.com/triqs/dft_tools synced 2024-11-18 12:03:50 +01:00
Code Issues Releases Wiki Activity

[doc] Clean issue templates and make them more concise

Browse Source
This commit is contained in:
Nils Wentzell 2019-09-17 14:00:03 -04:00
parent df33cb6ffd
commit bdee25bb1b
2 changed files with 13 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
.github/ISSUE_TEMPLATE/bug.md vendored
View File

@ -6,16 +6,9 @@ labels: bug
--- ---
<!--
NOTE: The issue list is not the place for general questions.
Please consider using the mailing list instead:
https://groups.google.com/a/flatironinstitute.org/forum/#!forum/triqs
-->
### Prerequisites ### Prerequisites
* [ ] Put an X between the brackets on this line if you have done all of the following: * Please check that a similar issue isn't already filed: https://github.com/issues?q=is%3Aissue+user%3Atriqs
* Checked that your issue isn't already filed: https://github.com/issues?utf8=%E2%9C%93&q=is%3Aissue+user%3Atriqs
### Description ### Description
@ -27,19 +20,25 @@ https://groups.google.com/a/flatironinstitute.org/forum/#!forum/triqs
2. [Second Step] 2. [Second Step]
3. [and so on...] 3. [and so on...]
or paste a minimal code example to reproduce the issue.
**Expected behavior:** [What you expect to happen] **Expected behavior:** [What you expect to happen]
**Actual behavior:** [What actually happens] **Actual behavior:** [What actually happens]
**Reproduces how often:** [What percentage of the time does it reproduce?]
### Versions ### Versions
Please provide the application version that you used.
You can get this information from copy and pasting the output of You can get this information from copy and pasting the output of
```bash ```bash
python -c "from app4triqs.version import *; show_version(); show_git_hash();" python -c "from app4triqs.version import *; show_version(); show_git_hash();"
``` ```
from the command line. Also, please include the OS and what version of the OS you're running. 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 ### Additional Information

17
.github/ISSUE_TEMPLATE/feature.md vendored
View File

@ -6,25 +6,14 @@ labels: feature
--- ---
<!--
NOTE: The issue list is not the place for general questions.
Please consider using the mailing list instead:
https://groups.google.com/a/flatironinstitute.org/forum/#!forum/triqs
-->
### Summary ### Summary
One paragraph explanation of the feature. One paragraph explanation of the feature.
### Motivation ### Motivation
Why are we doing this? What use cases does it support? What is the expected outcome? Why is this feature of general interest?
### Describe alternatives you've considered ### Implementation
A clear and concise description of the alternative solutions you've considered. What user interface do you suggest?
Be sure to explain why the existing customizability of app4triqs isn't suitable for this feature.
### Additional context
Add any other context about the feature request here.