Skip to content

Commit

Permalink
Add GitHub templates for issues
Browse files Browse the repository at this point in the history
  • Loading branch information
timofurrer committed Aug 24, 2019
1 parent a4fe768 commit 5d80bfc
Show file tree
Hide file tree
Showing 4 changed files with 98 additions and 7 deletions.
11 changes: 4 additions & 7 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Please make sure you provide enough information to work on your submitted Issue
* Which version of python are you using?
* On which platform are you running radish?

Make sure to use the GitHub Template when reporting an issue.

## Pull Requests

We are very happy to receive Pull Requests considering:
Expand All @@ -38,11 +40,6 @@ However, if you want to test your code on certain circumstances you can create a
cd ~/work/radish
virtualenv env
source env/bin/activate
pip install -r requirements-dev.txt
pip install .
coverage run -a --source radish -m pytest tests/ -s --failed-first
pip install -e '.[dev]'
commands = coverage run --parallel -m pytest -s --failed-first
```

## AUTHORS file
Please feel free to open a Pull Request and add yourself to the `AUTHORS` file. <br>
Well, ... only if you've done some considerable changes :beers:
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
name: Bug Report
about: Create a bug report to help us improve radish
title: ''
labels: ''
assignees: ''

---

**Important notices**
Before you add a new report, we ask you kindly to acknowledge the following:

[-] I have read the contributing guide lines at https://github.com/radish-bdd/radish/blob/master/.github/CONTRIBUTING.md

[-] I have read and respect the code of conduct at https://github.com/radish-bdd/radish/blob/master/.github/CODE_OF_CONDUCT.md

[-] I have searched the existing issues and I'm convinced that mine is new.

**Describe the bug**
A clear and concise description of what the bug is.

**Environment and Version**
* OS (incl. terminal and shell used): ...
* Python Version: ...
* radish Version (`radish --version`): ...

**To Reproduce**
A clear and concise description of steps to reproduce the behavior
you are experiencing.
This might also include a minial Feature File and Step Implementations.

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Relevant log files**
If applicable, information from log files supporting your claim.
Log files could be:
* text file with the radish console output
* generated report files

**Additional context**
Add any other context about the problem here.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Feature Request
about: Suggest an idea for a new feature or enhancement for radish
title: ''
labels: ''
assignees: ''

---

**Important notices**
Before you add a new request, we ask you kindly to acknowledge the following:

[-] I have read the contributing guide lines at https://github.com/radish-bdd/radish/blob/master/.github/CONTRIBUTING.md

[-] I have read and respect the code of conduct at https://github.com/radish-bdd/radish/blob/master/.github/CODE_OF_CONDUCT.md

[-] I have searched the existing issues and I'm convinced that mine is new.

**Is your Feature Request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Ask a Question
about: Ask a Question about radish (Usage, Development, ...)
title: ''
labels: ''
assignees: ''

---

**Important notices**
Before you add a new report, we ask you kindly to acknowledge the following:

[-] I have read the contributing guide lines at https://github.com/radish-bdd/radish/blob/master/.github/CONTRIBUTING.md

[-] I have read and respect the code of conduct at https://github.com/radish-bdd/radish/blob/master/.github/CODE_OF_CONDUCT.md

[-] I have searched the existing issues and I'm convinced that mine is new.

**Ask your Question**
Ask your question here! If the question is related to a particular environment or behavior please make sure to add some context.

0 comments on commit 5d80bfc

Please sign in to comment.