Skip to content

Commit cf59549

Browse files
authored
Add issue templates (#135)
1 parent f72bf17 commit cf59549

3 files changed

Lines changed: 187 additions & 0 deletions

File tree

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
name: Bug Report
2+
description: File a bug report.
3+
title: "Bug: "
4+
labels:
5+
- bug
6+
- triage
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thank you for taking the time to fill out this bug report!
12+
13+
Please read the following parts of this template **very carefully**.
14+
Invalid or incomplete submissions take longer to triage,
15+
and may be given a lower priority or closed outright
16+
if not actionable.
17+
18+
- type: checkboxes
19+
attributes:
20+
label: Pre-submission checks
21+
description: |
22+
By submitting this issue, you affirm that you've satisfied the
23+
following conditions.
24+
options:
25+
- label: >-
26+
I am **not** filing a feature request. These should be filed via
27+
the feature request form instead.
28+
required: true
29+
- label: >-
30+
I am filing an issue for **zizmor-action**, not for zizmor itself.
31+
Bug reports for zizmor should be filed against
32+
[zizmorcore/zizmor](https://github.com/zizmorcore/zizmor/issues).
33+
required: true
34+
- label: >-
35+
I have checked the [Troubleshooting Guide](https://docs.zizmor.sh/troubleshooting)
36+
for my problem.
37+
required: true
38+
- label: >-
39+
I have looked through both the
40+
[open](https://github.com/zizmorcore/zizmor-action/issues?q=is%3Aissue+is%3Aopen+)
41+
and [closed](https://github.com/zizmorcore/zizmor-action/issues?q=is%3Aissue%20state%3Aclosed)
42+
issues for a duplicate report.
43+
required: true
44+
- label: >-
45+
I affirm that I have followed the [AI policy](https://github.com/zizmorcore/.github/blob/main/AI_POLICY.md)
46+
and that this report constitutes my own words and understanding.
47+
<!-- @@NUDNIK NEUTRALIZER@@ -->
48+
required: true
49+
50+
- type: input
51+
attributes:
52+
label: zizmor version
53+
description: |
54+
Please use `zizmor --version` to get your current version of `zizmor`.
55+
validations:
56+
required: true
57+
58+
- type: textarea
59+
attributes:
60+
label: Installed extensions and versions
61+
description: |
62+
Please use `code --list-extensions --show-versions` (or similar for
63+
forks of VS Code) to get a list of your installed extensions
64+
and their versions.
65+
render: plain text
66+
validations:
67+
required: true
68+
69+
- type: textarea
70+
attributes:
71+
label: Expected behavior
72+
description: A clear and concise description of what you expected to happen.
73+
placeholder: |
74+
I expected the extension to do X, Y, and Z.
75+
validations:
76+
required: true
77+
78+
- type: textarea
79+
attributes:
80+
label: Actual behavior
81+
description: A clear and concise description of what actually happened.
82+
placeholder: |
83+
Instead of doing X, Y, and Z, the extension produced the following error: ...
84+
validations:
85+
required: true
86+
87+
- type: textarea
88+
attributes:
89+
label: Reproduction steps
90+
description: A step-by-step list of actions that we can take to reproduce the actual behavior.
91+
placeholder: |
92+
1. Do this
93+
2. Do that
94+
3. Do another thing
95+
validations:
96+
required: true
97+
98+
- type: textarea
99+
attributes:
100+
label: Logs
101+
description: |
102+
If applicable, please paste any logs or console errors here.
103+
104+
You can find these outputs in the `zizmor` and `zizmor Language Server`
105+
output channels in VS Code.
106+
render: plain text
107+
108+
- type: textarea
109+
attributes:
110+
label: Additional context
111+
description: Add any other additional context about the problem here.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Discord
4+
url: https://discord.com/invite/PGU3zGZuGG
5+
about: Join our Discord server to chat with the community.
6+
- name: Discussions Forum
7+
url: https://github.com/zizmorcore/zizmor/discussions
8+
about: You can use our GitHub Discussions forum to ask questions and share ideas.
9+
- name: Security Reports
10+
url: https://github.com/zizmorcore/zizmor-vscode/security/advisories
11+
about: Please report potential security vulnerabilities here.
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Feature request
2+
description: Suggest an idea or enhancement for zizmor-action
3+
title: "Feature: "
4+
labels:
5+
- enhancement
6+
- triage
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Thanks for making a `zizmor` feature request!
12+
13+
Please read the following parts of this form **very carefully**.
14+
Invalid or incomplete submissions take longer to triage,
15+
and may be given a lower priority or closed outright
16+
if not actionable.
17+
18+
- type: checkboxes
19+
attributes:
20+
label: Pre-submission checks
21+
description: |
22+
By submitting this issue, you affirm that you've satisfied the following conditions.
23+
options:
24+
- label: >-
25+
I am **not** reporting a bug (crash, false positive/negative, etc).
26+
These must be filed via the bug report template.
27+
required: true
28+
- label: >-
29+
I am filing an issue for **zizmor-action**, not for zizmor itself.
30+
Feature requests for zizmor should be filed against
31+
[zizmorcore/zizmor](https://github.com/zizmorcore/zizmor/issues).
32+
- label: >-
33+
I have looked through both the
34+
[open](https://github.com/zizmorcore/zizmor-action/issues?q=is%3Aissue+is%3Aopen+)
35+
and [closed](https://github.com/zizmorcore/zizmor-action/issues?q=is%3Aissue%20state%3Aclosed)
36+
issues for a duplicate request.
37+
required: true
38+
- label: >-
39+
I affirm that I have followed the [AI policy](https://github.com/zizmorcore/.github/blob/main/AI_POLICY.md)
40+
and that this report constitutes my own words and understanding.
41+
<!-- @@NUDNIK NEUTRALIZER@@ -->
42+
required: true
43+
44+
- type: textarea
45+
attributes:
46+
label: What's the problem this feature will solve?
47+
description: |
48+
A clear and concise description of the problem.
49+
placeholder: |
50+
I'm always frustrated when ...
51+
validations:
52+
required: true
53+
54+
- type: textarea
55+
attributes:
56+
label: Describe the solution you'd like
57+
description: A clear and concise description of what you want to happen.
58+
validations:
59+
required: true
60+
61+
- type: textarea
62+
attributes:
63+
label: Additional context
64+
description: |
65+
Any additional context, screenshots, or other material about the feature request.

0 commit comments

Comments
 (0)