Skip to content

Commit

Permalink
Added issue templates for Github. (epfl-ecps#3)
Browse files Browse the repository at this point in the history
The templates will be used as a starting point whenever a new issue
is opened. Can be extended later to more issue types than just "Feature
request" and "Bug report" in case it's needed.
  • Loading branch information
alalazo authored and symtor committed Aug 21, 2018
1 parent 8865b48 commit e702ced
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: Bug report
about: Create a report to help us improve

---


**Describe the bug**

Summarize your issue here in a couple of sentences. We encourage
you to try, as much as possible, to reduce your problem to the minimal example that still reproduces the issue.
That would help us a lot in fixing it quickly and effectively.
Other than that, thanks for taking the time to contribute to Channelflow!

**Expected Result**

What you expected

**Actual Result**

What happened instead

**Steps to reproduce the issue**

```console
$ mpirun simulate_flow ...
<relevant output>
...
```

**Information on your system**

This includes:

1. platform you are running on
2. relevant configuration details (CMake configuration, etc.)

**Additional context**

Add any other context about the problem here.
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is.

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

0 comments on commit e702ced

Please sign in to comment.