-
Notifications
You must be signed in to change notification settings - Fork 412
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* feat: add some issue templates close #565 * feat: add other issue template
- Loading branch information
Showing
8 changed files
with
254 additions
and
49 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,54 @@ | ||
name: 🐞 Bug report | ||
description: Report an issue for bug | ||
title: '[Bug report]' | ||
labels: [Bug report] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for taking the time to fill out this bug report! | ||
- type: textarea | ||
id: bug-description | ||
attributes: | ||
label: Describe the bug | ||
description: A clear and concise description of what the bug is. | ||
placeholder: Bug description | ||
validations: | ||
required: true | ||
- type: input | ||
id: reproduction | ||
attributes: | ||
label: Reproduction | ||
description: A [minimal reproduction](https://github.com/Tencent/cherry-markdown/tree/main/examples) is **required**,It is beneficial for solving your problem faster and better. | ||
placeholder: Reproduction | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: system-info | ||
attributes: | ||
label: System Info | ||
description: Output of `npx envinfo --system --binaries --browsers` | ||
render: Shell | ||
placeholder: System, Binaries, Browsers | ||
validations: | ||
required: true | ||
- type: checkboxes | ||
id: validations | ||
attributes: | ||
label: Validations | ||
description: Before submitting the issue, please make sure you do the following | ||
options: | ||
- label: Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. | ||
required: true | ||
- label: Check that this is a concrete bug. For Q&A, please open a [GitHub Discussion](https://github.com/Tencent/cherry-markdown/discussions) instead. | ||
required: true | ||
- label: The provided reproduction is a [minimal reproducible](https://stackoverflow.com/help/minimal-reproducible-example) of the bug. | ||
required: true | ||
- type: dropdown | ||
id: help-us | ||
attributes: | ||
label: Help us | ||
description: Do you plan to submit a PR for this issue? | ||
options: | ||
- Yes, I would like to try submitting a PR for this issue. | ||
- No, I don't want to do it now. |
This file was deleted.
Oops, something went wrong.
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,47 @@ | ||
name: 💻 clinet issue | ||
description: About clinet issue | ||
title: '[clinet]' | ||
labels: [clinet] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for your interest in the project and taking the time to fill out this feature report! | ||
- type: dropdown | ||
id: type | ||
attributes: | ||
label: issue type | ||
description: What type of issue is this about clients? | ||
options: | ||
- Bug | ||
- Feature | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: issue-description | ||
attributes: | ||
label: Clear and concise description of the problem or idea. | ||
placeholder: Questions or ideas. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Any other context or screenshots about the feature request here. | ||
- type: checkboxes | ||
id: checkboxes | ||
attributes: | ||
label: Validations | ||
description: Before submitting the issue, please make sure you do the following | ||
options: | ||
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. | ||
required: true | ||
- type: dropdown | ||
id: help-us | ||
attributes: | ||
label: Help us | ||
description: Do you plan to submit a PR for this issue? | ||
options: | ||
- Yes, I would like to try submitting a PR for this issue. | ||
- No, I don't want to do it now. |
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,47 @@ | ||
name: 📃 docs issue | ||
description: About docs issue | ||
title: '[docs]' | ||
labels: [docs] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for your interest in the project and taking the time to fill out this feature report! | ||
- type: dropdown | ||
id: type | ||
attributes: | ||
label: issue type | ||
description: What type of issue is this about docs? | ||
options: | ||
- Bug | ||
- Feature | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: issue-description | ||
attributes: | ||
label: Clear and concise description of the problem or idea. | ||
placeholder: Questions or ideas. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Any other context or screenshots about the feature request here. | ||
- type: checkboxes | ||
id: checkboxes | ||
attributes: | ||
label: Validations | ||
description: Before submitting the issue, please make sure you do the following | ||
options: | ||
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. | ||
required: true | ||
- type: dropdown | ||
id: help-us | ||
attributes: | ||
label: Help us | ||
description: Do you plan to submit a PR for this issue? | ||
options: | ||
- Yes, I would like to try submitting a PR for this issue. | ||
- No, I don't want to do it now. |
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: 🚀 New feature proposal | ||
description: Propose a new feature | ||
title: '[Feature report]' | ||
labels: [Feature report] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for your interest in the project and taking the time to fill out this feature report! | ||
- type: textarea | ||
id: feature-description | ||
attributes: | ||
label: Clear and concise description of the problem | ||
description: As a developer using cherry-markdown I want [goal / wish] so that [benefit]. | ||
placeholder: Feature description | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: suggested-solution | ||
attributes: | ||
label: Suggested solution | ||
description: 'I want a xx function that can be used to do xxx things. Its implementation is beneficial for...' | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Any other context or screenshots about the feature request here. | ||
- type: checkboxes | ||
id: checkboxes | ||
attributes: | ||
label: Validations | ||
description: Before submitting the issue, please make sure you do the following | ||
options: | ||
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. | ||
required: true | ||
- type: dropdown | ||
id: help-us | ||
attributes: | ||
label: Help us | ||
description: Do you plan to submit a PR for this issue? | ||
options: | ||
- Yes, I would like to try submitting a PR for this issue. | ||
- No, I don't want to do it now. |
This file was deleted.
Oops, something went wrong.
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,14 @@ | ||
--- | ||
name: Others | ||
about: Suggest an idea for this project | ||
title: '[Others]' | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your any problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
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,47 @@ | ||
name: 🔌 vscodePlugin issue | ||
description: About vscodePlugin issue | ||
title: '[vscodePlugin]' | ||
labels: [vscodePlugin] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Thanks for your interest in the project and taking the time to fill out this feature report! | ||
- type: dropdown | ||
id: type | ||
attributes: | ||
label: issue type | ||
description: What type of issue is this about vscodePlugin? | ||
options: | ||
- Bug | ||
- Feature | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: issue-description | ||
attributes: | ||
label: Clear and concise description of the problem or idea. | ||
placeholder: Questions or ideas. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional context | ||
description: Any other context or screenshots about the feature request here. | ||
- type: checkboxes | ||
id: checkboxes | ||
attributes: | ||
label: Validations | ||
description: Before submitting the issue, please make sure you do the following | ||
options: | ||
- label: Check that there isn't already an issue that request the same feature to avoid creating a duplicate. | ||
required: true | ||
- type: dropdown | ||
id: help-us | ||
attributes: | ||
label: Help us | ||
description: Do you plan to submit a PR for this issue? | ||
options: | ||
- Yes, I would like to try submitting a PR for this issue. | ||
- No, I don't want to do it now. |