Skip to content

Commit

Permalink
chore: add issues templates
Browse files Browse the repository at this point in the history
  • Loading branch information
shadowusr committed Mar 21, 2024
1 parent 9d860fe commit db1f06c
Show file tree
Hide file tree
Showing 3 changed files with 101 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Bug Report
description: Create a bug report for html-reporter
labels: ["type: bug"]
body:
- type: checkboxes
attributes:
label: Verify latest release
description: "Please run `npm install html-reporter@latest` to try the latest version of html-reporter. Some issues may already be fixed in the latest release, so please verify that your issue reproduces before opening a new issue."
options:
- label: I verified that the issue exists in the latest html-reporter release
- type: input
attributes:
label: Html-reporter version
description: e.g. 9.16.0
- type: input
id: last-working-version
attributes:
label: Last html-reporter version that worked
placeholder: e.g. 9.15.1
- type: input
attributes:
label: Link to the code that reproduces this issue or a replay of the bug
description: |
A link to a GitHub repository minimal reproduction. If a minimal reproduction can't be created please share a replay of the bug which doesn't require sharing a private repo.
- type: textarea
id: repro
attributes:
label: Reproduction steps
description: |
How do you trigger this bug? Please walk us through it step by step.
validations:
required: true
- type: markdown
attributes:
value: ----------------------------
- type: textarea
attributes:
label: Actual Behavior
description: A clear and concise description of what the bug is.
validations:
required: true
- type: markdown
attributes:
value: ----------------------------
- type: textarea
attributes:
label: Expected Behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: markdown
attributes:
value: ----------------------------
- type: input
attributes:
label: Which Node.js version are you using?
description: "Please specify the exact version. For example: 20.11.0"
validations:
required: true
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature Request
description: Suggest a new feature for html-reporter
labels: ["type: feature"]
body:
- type: markdown
attributes:
value: |
These issues are for **concrete and actionable proposals**. If you just have
a general problem that you would like to brainstorm, open a Discussion instead [here](https://github.com/gemini-testing/html-reporter/discussions).
- type: checkboxes
attributes:
label: Contribution
options:
- label: I'd be willing to implement this feature ([contributing guide](https://github.com/gemini-testing/html-reporter/blob/master/CONTRIBUTING.md))
- type: textarea
id: user-story
attributes:
label: Describe the user story
description: |
A clear and concise description of what workflow is meant to be improved. Example: "As a developer, I often want to do <something>, but I often face <problem>".
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen. Consider that html-reporter is used by many people, and your particular use case might not make sense to implement in the core.
validations:
required: true
- type: textarea
id: drawbacks
attributes:
label: Describe the drawbacks of your solution
description: This section is important not only to identify future issues, but also for us to see whether you thought through your request. Ask yourself, what are the problems we could have maintaining what you propose? How often will it break?
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: A clear and concise description of any alternative solutions or features you've considered, and why you think they wouldn't be good enough.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Question 🤷
url: https://github.com/gemini-testing/html-reporter/discussions
about: Ask questions and discuss with other community members

0 comments on commit db1f06c

Please sign in to comment.