Skip to content

Commit

Permalink
Add issue templates.
Browse files Browse the repository at this point in the history
  • Loading branch information
ionelmc committed Jan 12, 2020
1 parent b4b9bcc commit 9b8770b
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,32 @@
---
name: 🐞 Bug report
about: A problem with how pytest-cov or coverage works.
---

# Summary

## Expected vs actual result

# Reproducer

## Versions

Output of relevant packages `pip list`, `python --version`, `pytest --version` etc.

Make sure you include complete output of `tox` if you use it (it will show versions of various things).

## Config

Include your `tox.ini`, `pytest.ini`, `.coveragerc`, `setup.cfg` or any relevant configuration.

## Code

Link to your repository, gist, pastebin or just paste raw code that illustrates the issue.

If you paste raw code make sure you quote it, eg:

```python
def foobar():
pass
```

18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,18 @@
---
name: ✈ Feature request
about: Need help with configuring pytest-cov
---

Before proposing please consider:

* the maintenance cost of the feature
* implementing it externally (like a shell/python script,
pytest plugin or something else)

# Summary

These questions should be answered:

* why is the feature needed?
* what problem does it solve?
* how it is better compared to past solution to the problem?
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/support_request.md
@@ -0,0 +1,40 @@
---
name: 🤔 Support request
about: Need help with configuring pytest-cov
---

Please go over all the sections and search
https://pytest-cov.readthedocs.io/en/latest/ or
https://coverage.readthedocs.io/en/latest/
before opening the issue.

# Summary

## Expected vs actual result

# Reproducer

## Versions

Output of relevant packages `pip list`, `python --version`, `pytest --version` etc.

Make sure you include complete output of `tox` if you use it (it will show versions of various things).

## Config

Include your `tox.ini`, `pytest.ini`, `.coveragerc`, `setup.cfg` or any relevant configuration.

## Code

Link to your repository, gist, pastebin or just paste raw code that illustrates the issue.

If you paste raw code make sure you quote it, eg:

```python
def foobar():
pass
```

# What has been tried to solve the problem

You should outline the things you tried to solve the problem but didn't work.

0 comments on commit 9b8770b

Please sign in to comment.