Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create issue templates #387

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug.md
Original file line number Diff line number Diff line change
@@ -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 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/2-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] "
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 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/3-doc.md
Original file line number Diff line number Diff line change
@@ -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 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
blank_issues_enabled: true

11 changes: 11 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -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. -->