Skip to content

Commit

Permalink
Add github issue templates for bug and feature request
Browse files Browse the repository at this point in the history
  • Loading branch information
Wentzell committed Oct 16, 2019
1 parent ef74ea3 commit 762435c
Show file tree
Hide file tree
Showing 2 changed files with 68 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -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.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -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).

0 comments on commit 762435c

Please sign in to comment.