Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(*): update issue templates #645

Merged
merged 1 commit into from
Nov 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 0 additions & 47 deletions .github/ISSUE_TEMPLATE/bug-report.yml

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: 🐞 Bug Report
description: Report a bug
title: '[Bug Report]'
labels: [bug]
body:
- type: markdown
attributes:
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:
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
attributes:
label: Describe the Bug
description: Provide a clear and concise description of the bug.
validations:
required: true
- type: input
id: reproduction
attributes:
label: Reproduction Steps
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
- 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:
label: Contributing
description: Would you consider contributing a PR for this issue?
options:
- Yes, I would like to submit a PR for this issue.
- No, I don't plan to at this time.
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/client-report.yml

This file was deleted.

46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/client_feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: 💻 Client Feedback
description: Client feedback
title: '[Client]'
labels: [client]
body:
- type: markdown
attributes:
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:
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?
options:
- Bug Report
- Feature 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: 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:
label: Contributing
description: Would you consider contributing a PR for this issue?
options:
- Yes, I'd like to submit a PR for this issue.
- No, I don't plan to at this time.
46 changes: 0 additions & 46 deletions .github/ISSUE_TEMPLATE/docs-report.yml

This file was deleted.

47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: 📃 Documentation Feedback
description: Ask a question or submit a bug related to our documentation
title: '[Docs]'
labels: [docs]
body:
- type: markdown
attributes:
value: |
Thank you for your interest in the project and taking the time to provide your feedback.
- 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:
label: Issue Type
description: What type of issue is this?
options:
- Question
- Documentation Error
- 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:
label: Contributing
description: Would you consider contributing a PR for this issue?
options:
- Yes, I'd like to submit a PR for this issue.
- No, I don't plan to at this time.
Original file line number Diff line number Diff line change
@@ -1,12 +1,19 @@
name: 🚀 New feature proposal
description: Propose a new feature
title: '[Feature report]'
labels: [Feature report]
description: Suggest an idea for this project
title: '[Feature Request]'
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
Thanks for your interest in the project and taking the time to fill out this feature report!
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:
options:
- label: There isn't an existing issue that requests the same feature, to avoid duplicates.
- type: textarea
id: feature-description
attributes:
Expand All @@ -23,20 +30,13 @@ body:
- 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.
label: Further Information
description: Provide any other relevant information or screenshots about the feature request here.
- type: dropdown
id: help-us
attributes:
label: Help us
description: Do you plan to submit a PR for this issue?
label: Contributing
description: Would you consider contributing 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.
- Yes, I'd like to submit a PR for this issue.
- No, I don't plan to at this time.
Loading