From f4d30065d32d0180e3d98ea6ed7a6e70f2a83899 Mon Sep 17 00:00:00 2001 From: Frank Dana Date: Sat, 15 Jun 2024 12:06:24 -0400 Subject: [PATCH 1/2] 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). --- .github/ISSUE_TEMPLATE/1-bug.md | 36 +++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/2-feature.md | 23 ++++++++++++++++++ .github/ISSUE_TEMPLATE/3-doc.md | 26 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 2 ++ .github/issue_template.md | 11 +++++++++ 5 files changed, 98 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-bug.md create mode 100644 .github/ISSUE_TEMPLATE/2-feature.md create mode 100644 .github/ISSUE_TEMPLATE/3-doc.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/1-bug.md b/.github/ISSUE_TEMPLATE/1-bug.md new file mode 100644 index 000000000..29923e504 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug.md @@ -0,0 +1,36 @@ +--- +name: Bug report +about: Create a report to help us improve WireViz +title: "[bug] " +labels: 'bug' +assignees: '' + +--- + + + +**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. diff --git a/.github/ISSUE_TEMPLATE/2-feature.md b/.github/ISSUE_TEMPLATE/2-feature.md new file mode 100644 index 000000000..8911d7782 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[feature] " +labels: 'enhancement' +assignees: '' + +--- + + + +**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. diff --git a/.github/ISSUE_TEMPLATE/3-doc.md b/.github/ISSUE_TEMPLATE/3-doc.md new file mode 100644 index 000000000..3176db027 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-doc.md @@ -0,0 +1,26 @@ +--- +name: Documentation issue template +about: Help us improve the WireViz documentation +title: "[doc] " +labels: 'documentation' +assignees: '' + +--- + + +**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. + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..b92c70cbb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,2 @@ +blank_issues_enabled: true + diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 000000000..17cec5f56 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,11 @@ + + From 4f11e32256888a2e4807e3492d3fd5f1a73259bb Mon Sep 17 00:00:00 2001 From: "FeRD (Frank Dana)" Date: Sun, 22 Jun 2025 23:18:24 -0400 Subject: [PATCH 2/2] Remove 'template' from docs issue title --- .github/ISSUE_TEMPLATE/3-doc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3-doc.md b/.github/ISSUE_TEMPLATE/3-doc.md index 3176db027..29c0b4c10 100644 --- a/.github/ISSUE_TEMPLATE/3-doc.md +++ b/.github/ISSUE_TEMPLATE/3-doc.md @@ -1,5 +1,5 @@ --- -name: Documentation issue template +name: Documentation issue about: Help us improve the WireViz documentation title: "[doc] " labels: 'documentation'