Create issue templates
Add templates for bug, feature, and doc issues, based on GitHub's standard templates. Also create an `issue_template.md` file for blank issues of other types, and configure the template selector to allow "blank" issues (which will use that template).
This commit is contained in:
parent
954c4f5f92
commit
f4d30065d3
36
.github/ISSUE_TEMPLATE/1-bug.md
vendored
Normal file
36
.github/ISSUE_TEMPLATE/1-bug.md
vendored
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
name: Bug report
|
||||||
|
about: Create a report to help us improve WireViz
|
||||||
|
title: "[bug] "
|
||||||
|
labels: 'bug'
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!-- Please add a brief summary of your issue to the title above, after the
|
||||||
|
"[bug]" prefix -->
|
||||||
|
|
||||||
|
**Describe the bug**
|
||||||
|
A clear and concise description of what the bug is.
|
||||||
|
|
||||||
|
**To Reproduce**
|
||||||
|
Steps to reproduce the behavior:
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
|
||||||
|
**Expected behavior**
|
||||||
|
A clear and concise description of what you expected to happen.
|
||||||
|
|
||||||
|
**Screenshots**
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
|
**Desktop (please complete the following information):**
|
||||||
|
- WireViz version:
|
||||||
|
- Graphviz version (`dot -V`):
|
||||||
|
- Python version: (`python -V`):
|
||||||
|
- Operating System and version:
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context about the problem here.
|
||||||
23
.github/ISSUE_TEMPLATE/2-feature.md
vendored
Normal file
23
.github/ISSUE_TEMPLATE/2-feature.md
vendored
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
---
|
||||||
|
name: Feature request
|
||||||
|
about: Suggest an idea for this project
|
||||||
|
title: "[feature] "
|
||||||
|
labels: 'enhancement'
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<!-- Please add a brief summary of your request to the title above, after the
|
||||||
|
"[feature]" prefix -->
|
||||||
|
|
||||||
|
**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.
|
||||||
26
.github/ISSUE_TEMPLATE/3-doc.md
vendored
Normal file
26
.github/ISSUE_TEMPLATE/3-doc.md
vendored
Normal file
@ -0,0 +1,26 @@
|
|||||||
|
---
|
||||||
|
name: Documentation issue template
|
||||||
|
about: Help us improve the WireViz documentation
|
||||||
|
title: "[doc] "
|
||||||
|
labels: 'documentation'
|
||||||
|
assignees: ''
|
||||||
|
|
||||||
|
---
|
||||||
|
<!-- Please add a brief summary of your issue to the title above, after the
|
||||||
|
"[doc]" prefix -->
|
||||||
|
|
||||||
|
**What documentation page(s) does this involve?**
|
||||||
|
Links to the relevant documentation files, e.g. [docs/README.md][].
|
||||||
|
|
||||||
|
**Describe the problem**
|
||||||
|
A clear and concise description of the documentation issue.
|
||||||
|
|
||||||
|
**Describe your suggested improvement**
|
||||||
|
A clear and concise summary of how the documentation could be better.
|
||||||
|
|
||||||
|
**Screenshots**
|
||||||
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
|
**Additional context**
|
||||||
|
Add any other context about the problem here.
|
||||||
|
|
||||||
2
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
2
.github/ISSUE_TEMPLATE/config.yml
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
blank_issues_enabled: true
|
||||||
|
|
||||||
11
.github/issue_template.md
vendored
Normal file
11
.github/issue_template.md
vendored
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<!-- Where appropriate, prefix your issue title with one of these
|
||||||
|
category prefixes, followed by a space:
|
||||||
|
|
||||||
|
[internal] - When suggesting code improvements that don't change
|
||||||
|
any output.
|
||||||
|
[meta] - For issues about the development or contribution process.
|
||||||
|
|
||||||
|
For [bug], [feature], or [doc] issues, please use the corresponding
|
||||||
|
issue templates if possible, as they provide more guidance on what
|
||||||
|
information to include. -->
|
||||||
|
|
||||||
Loading…
x
Reference in New Issue
Block a user