Skip to content

Commit

Permalink
chore(ci): 增强issue的label分类和template的提示 (#945)
Browse files Browse the repository at this point in the history
* chore(ci): 增强issue的`label`分类和`template`的提示

* chore: 增强图标

* 更新文档issue的label匹配

* 统一version的 placeholder

* 更新排序和单词拼写错误

* 统一格式
  • Loading branch information
RSS1102 authored Oct 11, 2024
1 parent 796b087 commit 45d0b45
Show file tree
Hide file tree
Showing 7 changed files with 117 additions and 57 deletions.
Original file line number Diff line number Diff line change
@@ -1,41 +1,58 @@
name: 🐞 Bug Report
description: Report a bug
title: '[Bug Report]'
labels: [bug]
title: "[Bug Report]"
labels: [🐞bug, pending-no-confirmed]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report this bug.
value: Thank you for taking the time to report this bug.

- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
description: 'Before submitting the issue, ensure the following:'
description: "Before submitting the issue, ensure the following:"
options:
- label: There isn't an existing issue that reports the same bug to avoid duplicates.
- label: The provided information offers a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) of the bug.
- label: For Q&A, please open a [GitHub Discussion](https://github.com/Tencent/cherry-markdown/discussions) instead.
- type: textarea
id: bug-description
- label: |
The provided information offers a [minimal reproducible example](https://github.com/Tencent/cherry-markdown/tree/main/examples) of the bug
([Why create a Minimal, Reproducible Example](https://stackoverflow.com/help/minimal-reproducible-example)).
- label: |
For [Q&A](https://github.com/Tencent/cherry-markdown/discussions/categories/q-a),
please open a [GitHub Discussion](https://github.com/Tencent/cherry-markdown/discussions) instead.
- type: input
id: version
attributes:
label: Describe the Bug
description: Provide a clear and concise description of the bug.
label: Version
description: Providing the current version of cherry-markdown that will generate bugs.
placeholder: "v1.0.0"
validations:
required: true

- type: input
id: reproduction
attributes:
label: Reproduction Steps
label: Reproduction Link
description: A [minimal reproduction](https://github.com/Tencent/cherry-markdown/tree/main/examples) is **required**. It helps us resolve your issue faster and more effectively.
placeholder: Reproduction Steps
placeholder: Reproduction Link

- type: textarea
id: bug-description
attributes:
label: Describe the Bug
description: Provide a clear and concise description of the bug.
validations:
required: true

- type: textarea
id: system-info
attributes:
label: System Information
description: Output of `npx envinfo --system --binaries --browsers`
render: Shell
placeholder: System, Binaries, Browsers

- type: dropdown
id: help-us
attributes:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,37 +1,41 @@
name: 🚀 New feature proposal
name: 🚀 New Feature Request
description: Suggest an idea for this project
title: '[Feature Request]'
labels: [enhancement]
title: "[Feature Request]"
labels: [🚀enhancement, pending-no-confirmed]
body:
- type: markdown
attributes:
value: |
Thank you for your interest in the project and taking the time to fill out this feature report!
value: Thank you for your interest in the project and taking the time to fill out this feature report.

- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
description: 'Before submitting the issue, ensure the following:'
description: "Before submitting the issue, ensure the following:"
options:
- label: There isn't an existing issue that requests the same feature, to avoid duplicates.

- 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].
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...'
description: "I want a xx function that can be used to do xxx things. Its implementation is beneficial for..."

- type: textarea
id: additional-context
attributes:
label: Further Information
description: Provide any other relevant information or screenshots about the feature request here.

- type: dropdown
id: help-us
attributes:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
name: 📃 Documentation Feedback
description: Ask a question or submit a bug related to our documentation
title: '[Docs]'
labels: [docs]
title: "[Docs]"
labels: [📃documentation, pending-no-confirmed]
body:
- type: markdown
attributes:
value: |
Thank you for your interest in the project and taking the time to provide your feedback.
[For current usage documentation, please see here.](https://github.com/Tencent/cherry-markdown/wiki)
- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
description: 'Before submitting the issue, ensure the following:'
options:
- label: There isn't an existing issue with the same question or request to avoid duplicates.

- type: dropdown
id: type
attributes:
Expand All @@ -25,18 +28,21 @@ body:
- Update Request
validations:
required: true

- type: textarea
id: issue-description
attributes:
label: Description of the Problem or Idea
placeholder: Describe your questions or share your ideas here.
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Further Information
description: Provide any other relevant information or screenshots about the question here.

- type: dropdown
id: help-us
attributes:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,41 +1,54 @@
name: 💻 Client Feedback
description: Client feedback
title: '[Client]'
labels: [client]
title: "[Client]"
labels: [💻client, pending-no-confirmed]
body:
- type: markdown
attributes:
value: |
Thank you for your interest in the project and for taking the time to provide your feedback.
value: Thank you for your interest in the project and for taking the time to provide your feedback.

- type: checkboxes
id: prerequisites
attributes:
label: Prerequisites
description: 'Before submitting the issue, ensure the following:'
description: "Before submitting the issue, ensure the following:"
options:
- label: There isn't an existing issue that requests the same feature, to avoid duplicates.

- type: dropdown
id: type
attributes:
label: Issue Type
description: What type of issue is this?
description: What type of issue is this?
options:
- Bug Report
- Feature Request
validations:
required: true
required: true

- type: input
id: version
attributes:
label: Version
description: If it is a bug, please tell us which version the bug occurred in. If it is a Feature, please tell us which version you are currently using.
placeholder: v1.0.0
validations:
required: true

- type: textarea
id: issue-description
attributes:
label: Description of the Problem or Idea
placeholder: Describe your questions or share your ideas here.
validations:
required: true

- type: textarea
id: further-info
attributes:
label: Further Information
description: Provide any other relevant information or screenshots about the feature request here.

- type: dropdown
id: help-us
attributes:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,46 +1,59 @@
name: 🔌 VSCode Plugin issue
name: 🔌 VSCode Plugin Feedback
description: About VSCode Plugin issue
title: '[VSCode Plugin]'
labels: [VSCode Plugin]
title: "[VSCode Plugin]"
labels: [🔌vscode-plugin, pending-no-confirmed]
body:
- type: markdown
attributes:
value: |
Thanks for your interest in the project and taking the time to fill out this feature report!
value: Thank you for your interest in the project and for taking the time to provide your feedback.

- 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.

- type: dropdown
id: type
attributes:
label: issue type
description: What type of issue is this about VSCode Plugin?
label: Issue Type
description: What type of issue is this?
options:
- Bug
- Feature
- Bug Report
- Feature Request
validations:
required: true

- type: input
id: version
attributes:
label: Version
description: If it is a bug, please tell us which version the bug occurred in. If it is a Feature, please tell us which version you are currently using.
placeholder: v1.0.0
validations:
required: true
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.

- type: dropdown
id: help-us
attributes:
label: Help us
description: Do you plan to submit a PR for this issue?
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.
9 changes: 0 additions & 9 deletions .github/ISSUE_TEMPLATE/other.md

This file was deleted.

16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/other_feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: ✏️ Others
description: If none of them are in other ranges, please use this to illustrate.
title: "[Others]"
labels: [pending-no-confirmed]
body:
- type: markdown
attributes:
value: Thank you for your interest in the project and for taking the time to provide your feedback.

- type: textarea
id: issue-description
attributes:
label: Clear and concise description of the problem or idea.
placeholder: Questions or ideas.
validations:
required: true

0 comments on commit 45d0b45

Please sign in to comment.