-
Notifications
You must be signed in to change notification settings - Fork 64
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #839 from miripiruni/master
feat: issue templates
- Loading branch information
Showing
4 changed files
with
190 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
name: Bug Report | ||
description: Create a bug report for Hermione | ||
labels: ["type: bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
If this issue affects many people in a company/big team, create a post for your company in the following discussion: | ||
[https://github.com/gemini-testing/hermione/discussions/838](https://github.com/gemini-testing/hermione/discussions/838) | ||
and link the issue in your post. | ||
This will help us prioritize issues that affect more people. | ||
- type: checkboxes | ||
attributes: | ||
label: Verify latest release | ||
description: "Please run `npm install hermione@latest` to try the latest version of Hermione. 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 Hermione release | ||
- type: input | ||
attributes: | ||
label: Hermione version | ||
description: Fill only if you are not using the latest major version (v8) | ||
- type: dropdown | ||
attributes: | ||
label: Which area(s) of Hermione are affected? (leave empty if unsure) | ||
multiple: true | ||
options: | ||
- "Hermione core" | ||
- "Plugins" | ||
- "Configuration" | ||
- "CLI" | ||
- "Runner" | ||
- "Reporters" | ||
- "API" | ||
- 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. | ||
How to create example: | ||
1. npm init hermione-app my-example | ||
2. add reproduction steps to the my-example dir | ||
3. commit and push my-example dir to github | ||
validations: | ||
required: true | ||
- type: markdown | ||
attributes: | ||
value: ---------------------------- | ||
- type: textarea | ||
attributes: | ||
label: Describe the Bug | ||
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
name: Regression Report | ||
description: Report a regression in Hermione | ||
labels: ["type: regression"] | ||
body: | ||
- type: input | ||
id: last-working-version | ||
attributes: | ||
label: Last Hermione version that worked | ||
placeholder: e.g. 8.0.3 | ||
- type: input | ||
id: current-version | ||
attributes: | ||
label: Hermione version | ||
placeholder: e.g. 8.0.5 | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: code-to-reproduce | ||
attributes: | ||
label: Code to reproduce the issue | ||
description: Please provide a clear set of steps or a code snippet to reproduce the issue. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected-behavior | ||
attributes: | ||
label: Expected behavior | ||
description: Describe what you expected to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: actual-behavior | ||
attributes: | ||
label: Actual behavior | ||
description: Describe what actually happened. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-information | ||
attributes: | ||
label: Additional information | ||
description: Provide any additional details or context that might be relevant. | ||
- type: input | ||
id: node-version | ||
attributes: | ||
label: Node.js version | ||
description: "Run `node -v` and provide the output." | ||
placeholder: e.g. 20.11.0 | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: operating-system | ||
attributes: | ||
label: Operating System | ||
options: | ||
- macOS | ||
- Windows | ||
- Linux | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
name: Feature Request | ||
description: Suggest a new feature for Hermione | ||
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/hermione/discussions). | ||
- type: markdown | ||
attributes: | ||
value: | | ||
If this feature affects many people in a company/big team, create a post for your company in the following discussion: | ||
[https://github.com/gemini-testing/hermione/discussions/838](https://github.com/gemini-testing/hermione/discussions/838) | ||
and link the issue in your post. | ||
This will help us prioritize issues that affect more people. | ||
- type: checkboxes | ||
attributes: | ||
label: Contribution | ||
options: | ||
- label: I'd be willing to implement this feature ([contributing guide](https://github.com/gemini-testing/hermione/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 Hermione 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Question 🤷 | ||
url: https://github.com/gemini-testing/hermione/discussions | ||
about: Ask questions and discuss with other community members | ||
- name: My company is migrating to Hermione and we have several issues/feature requests | ||
url: https://github.com/gemini-testing/hermione/discussions/838 |