-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(repo): add issue and feature request templates (#29)
add templates for github's issue reporter and feature requests
- Loading branch information
1 parent
fcdd082
commit d86f195
Showing
2 changed files
with
107 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,68 @@ | ||
name: 🐛 Bug Report | ||
description: Create a report to help us improve Stencil Web Types | ||
title: 'bug: ' | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Prerequisites | ||
description: Please ensure you have completed all of the following. | ||
options: | ||
- label: I have read the [Contributing Guidelines](https://github.com/stencil-community/stencil-web-types/blob/main/CONTRIBUTING.md). | ||
required: true | ||
- label: I agree to follow the [Code of Conduct](https://github.com/stencil-community/stencil-web-types/blob/main/CODE_OF_CONDUCT.md). | ||
required: true | ||
- label: I have searched for [existing issues](https://github.com/stencil-community/stencil-web-types/issues) that already report this problem, without success. | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Stencil Web Types Version | ||
description: The version number of Stencil Web Types where the issue is occurring. | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Stencil Version | ||
description: The version number of Stencil where the issue is occurring. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Current Behavior | ||
description: A clear description of what the bug is and how it manifests. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Expected Behavior | ||
description: A clear description of what you expected to happen. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: System Info | ||
description: | | ||
Output of `npx stencil info`. | ||
Please provide any additional information, such as npm version, IDE, IDE version(s) as well | ||
render: shell | ||
placeholder: System, Environment, IDEs. At minimum, please include `npx stencil info` output and the IDE you're seeing this issue in | ||
- type: textarea | ||
attributes: | ||
label: Steps to Reproduce | ||
description: Please explain the steps required to duplicate this issue. | ||
validations: | ||
required: true | ||
- type: input | ||
attributes: | ||
label: Code Reproduction URL | ||
description: | | ||
Please reproduce this issue in a blank Stencil component starter and provide a link to the repo. | ||
Run `npm init stencil@latest component` to quickly spin up a Stencil project. | ||
This is the best way to ensure this issue is triaged quickly. | ||
Issues that do not include a code reproduction are likely to be be closed without any investigation. | ||
placeholder: https://github.com/... | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Additional Information | ||
description: List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. |
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,39 @@ | ||
name: 💡 Feature Request | ||
description: Suggest an idea for Stencil Web Types | ||
title: 'feat: ' | ||
body: | ||
- type: checkboxes | ||
attributes: | ||
label: Prerequisites | ||
description: Please ensure you have completed all of the following. | ||
options: | ||
- label: I have read the [Contributing Guidelines](https://github.com/stencil-community/stencil-web-types/blob/main/CONTRIBUTING.md). | ||
required: true | ||
- label: I agree to follow the [Code of Conduct](https://github.com/stencil-community/stencil-web-types/blob/main/CODE_OF_CONDUCT.md). | ||
required: true | ||
- label: I have searched for [existing issues](https://github.com/stencil-community/stencil-web-types/issues) that already include this feature request, without success. | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Describe the Feature Request | ||
description: A clear and concise description of what the feature does. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Describe the Use Case | ||
description: A clear and concise use case for what problem this feature would solve. | ||
validations: | ||
required: true | ||
- type: textarea | ||
attributes: | ||
label: Describe Preferred Solution | ||
description: A clear and concise description of how you want this feature to be added to the project. | ||
- type: textarea | ||
attributes: | ||
label: Describe Alternatives | ||
description: A clear and concise description of any alternative solutions or features you have considered. | ||
- type: textarea | ||
attributes: | ||
label: Additional Information | ||
description: List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to implement, Stack Overflow links, forum links, etc. |