Skip to content

Commit

Permalink
Updated GitHub issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
mrjackyliang committed Jan 31, 2024
1 parent 66b02f2 commit 67ecdf5
Show file tree
Hide file tree
Showing 3 changed files with 88 additions and 15 deletions.
37 changes: 28 additions & 9 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
@@ -1,47 +1,57 @@
name: Bug Report
description: Found an unexpected issue or problem? Report it here.
title: "[Bug]: "
labels: ["bug"]
labels: [ "bug" ]
body:
- type: markdown
attributes:
value: I truly appreciate you taking the time to share this bug report with me.
- type: markdown
attributes:
value: Please __fill out the form with as much detail as possible__ so the contributors can easily recreate the bug and work swiftly to assist you in resolving it. Thank you for your cooperation!
value: Please __fill out the form with as much detail as possible__ so I can easily recreate the bug and work swiftly to assist you in resolving it. Thank you for your cooperation!
- type: markdown
attributes:
value: ---
- type: checkboxes
id: pre-check
attributes:
label: Pre-check confirmation
description: Before proceeding further, please confirm the following by checking each box. This confirmation is crucial for contributors to effectively identify and address the bug. __All boxes MUST be checked; failure to comply will result in the immediate closure of this bug report.__
description: Before proceeding further, please confirm the following by checking each box. This confirmation is crucial for me to effectively identify and address the bug. __All boxes MUST be checked; failure to comply will result in the immediate closure of this bug report.__
options:
- label: I have provided a descriptive title for the bug I am having
- label: I have provided a descriptive title for the bug I am currently having
required: true
- label: "I have kept the original title prefix, __\"[Bug]: \"__"
required: true
- label: I have done my research, and this is __NOT__ a duplicate bug report
- label: I have read the `README.md` file, and this is __NOT__ a duplicate bug report
required: true
- label: I am __NOT__ requesting a new feature
required: true
- label: I am not requesting help that is related to a support request
required: true
- type: input
id: email
attributes:
label: Your email address
description: Help the contributors easily get in touch with you if they need more information. __If possible, please consider using an alias you have access to as this information is publicly visible.__
description: Help me easily get in touch with you if I need more information. __If possible, please consider using an alias you have access to as this information is publicly visible.__
placeholder: e.g. [email protected]
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: Tell us exactly what happened
label: Tell me exactly what happened
description: Provide a comprehensive description of __the steps or circumstances__ that led to the occurrence of this bug.
placeholder: e.g. When I was doing ..., I expected ... to happen, but I got ... instead.
validations:
required: true
- type: input
id: program-version
attributes:
label: Program version
description: What version of the program are you using? You may find this information inside the `package.json` file, where it says `version`.
placeholder: e.g. 1.0.0
validations:
required: true
- type: input
id: node-version
attributes:
Expand All @@ -53,16 +63,25 @@ body:
- type: textarea
id: logs
attributes:
label: Logs relevant to this bug
label: Captured logs relevant to this report
description: Copy and paste all logs related to this bug. __Do not include logs unrelated to this project.__ This block will be automatically formatted into code, so __no need for backticks__ or special markup.
placeholder: Please include logs relevant to this bug report. If this is filled with miscellaneous content (e.g. no logs, cannot find logs), this bug report will be closed immediately.
render: Shell
validations:
required: true
- type: checkboxes
id: post-check
attributes:
label: Post-check confirmation
description: Before proceeding further, please confirm the following by checking each box. This confirmation is crucial for the consideration of your request. __All boxes MUST be checked; failure to comply will result in your request being closed.__
options:
- label: I have filled in the form __exactly as requested__ and did not attempt to circumvent form validation
required: true
- type: checkboxes
id: legal
attributes:
label: Legal Agreements
description: By submitting a new bug report, you confirm that you have read, understood, and agree to the [Terms of Use](https://www.cbnventures.io/terms/) and [Privacy Policy](https://www.cbnventures.io/privacy/). If you have questions about these policies, feel free to [get in touch](https://www.cbnventures.io/get-in-touch/) with us.
description: By submitting a new bug report, you confirm that you have read, understood, and agree to the [Terms of Use](https://www.cbnventures.io/terms/) and [Privacy Policy](https://www.cbnventures.io/privacy/). If you have questions about these policies, feel free to [get in touch](https://www.cbnventures.io/get-in-touch/) with my team.
options:
- label: I agree to the Terms of Use and Privacy Policy
required: true
20 changes: 14 additions & 6 deletions .github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
name: Feature Request
description: Have a new feature in mind? Share your request with me.
title: "[Feature]: "
labels: ["enhancement"]
labels: [ "enhancement" ]
body:
- type: markdown
attributes:
value: Thank you for contributing to the improvement of this project by submitting a feature request!
- type: markdown
attributes:
value: Please __fill out the form with as much detail as possible__ to help the contributors understand your feature request better. Your input is valuable in shaping the future of this project.
value: Please __fill out the form with as much detail as possible__ to help me understand your feature request better. Your input is valuable in shaping the future of this project.
- type: markdown
attributes:
value: ---
- type: checkboxes
id: pre-check
attributes:
label: Pre-check confirmation
description: Before proceeding further, please confirm the following by checking each box. This confirmation is crucial for the consideration of your request. __All boxes MUST be checked; failure to comply may result in your request being closed.__
description: Before proceeding further, please confirm the following by checking each box. This confirmation is crucial for the consideration of your request. __All boxes MUST be checked; failure to comply will result in your request being closed.__
options:
- label: I have provided a descriptive title for my feature request
required: true
Expand All @@ -28,23 +28,31 @@ body:
id: email
attributes:
label: Your email address
description: Help the contributors easily get in touch with you if they need more information. __If possible, please consider using an alias you have access to as this information is publicly visible.__
description: Help me easily get in touch with you if I need more information. __If possible, please consider using an alias you have access to as this information is publicly visible.__
placeholder: e.g. [email protected]
validations:
required: true
- type: textarea
id: feature-description
attributes:
label: Describe the new feature requested
description: Provide a detailed description of the feature you would like to see implemented. Include any relevant information or use cases that might help the contributors understand the need for this feature.
description: Provide a detailed description of the feature you would like to see implemented. Include any relevant information or use cases that might help me understand the need for this feature.
placeholder: e.g. I would like a new feature that allows...
validations:
required: true
- type: checkboxes
id: post-check
attributes:
label: Post-check confirmation
description: Before proceeding further, please confirm the following by checking each box. This confirmation is crucial for the consideration of your request. __All boxes MUST be checked; failure to comply will result in your request being closed.__
options:
- label: I have filled in the form __exactly as requested__ and did not attempt to circumvent form validation.
required: true
- type: checkboxes
id: legal
attributes:
label: Legal Agreements
description: By submitting a new feature request, you confirm that you have read, understood, and agree to the [Terms of Use](https://www.cbnventures.io/terms/) and [Privacy Policy](https://www.cbnventures.io/privacy/). If you have questions about these policies, feel free to [get in touch](https://www.cbnventures.io/get-in-touch/) with us.
description: By submitting a new feature request, you confirm that you have read, understood, and agree to the [Terms of Use](https://www.cbnventures.io/terms/) and [Privacy Policy](https://www.cbnventures.io/privacy/). If you have questions about these policies, feel free to [get in touch](https://www.cbnventures.io/get-in-touch/) with my team.
options:
- label: I agree to the Terms of Use and Privacy Policy
required: true
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/SUPPORT-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Support Request
description: Get prioritized help with environment-specific deployment, general guidance, and upgrade assistance.
title: "[Support]: "
labels: [ "question" ]
body:
- type: markdown
attributes:
value: Please note support requests are __granted solely to members__ who are my sponsors or have heavily contributed to this project (these contributors will be listed at the bottom of the `README.md` file). If you would like to sponsor me, please consider checking out my [GitHub Sponsors](https://github.com/sponsors/mrjackyliang) page.
- type: markdown
attributes:
value: Please __fill out the form with as much detail as possible__ to help us resolve your request in a timely fashion. Thank you!
- type: markdown
attributes:
value: ---
- type: checkboxes
id: pre-check
attributes:
label: Pre-check confirmation
description: Before proceeding further, please confirm the following by checking each box. This confirmation is required. __All boxes MUST be checked; failure to comply will result in your request being closed.__
options:
- label: I am currently sponsoring you or have heavily contributed to this project.
required: true
- label: "I have kept the original title prefix, __\"[Support]: \"__"
required: true
- type: textarea
id: what-happened
attributes:
label: Tell me exactly what happened
description: Provide a comprehensive description of what you need help with and what is the result you expect from it.
placeholder: e.g. When I was doing ..., I expected ... to happen, but I got ... instead.
validations:
required: true
- type: textarea
id: logs
attributes:
label: Logs relevant to this issue
description: If you have any logs, you may copy and paste these logs related to this request here. This block will be automatically formatted into code, so __no need for backticks__ or special markup.
render: Shell
- type: checkboxes
id: legal
attributes:
label: Legal Agreements
description: By submitting a new support request, you confirm that you have read, understood, and agree to the [Terms of Use](https://www.cbnventures.io/terms/) and [Privacy Policy](https://www.cbnventures.io/privacy/). If you have questions about these policies, feel free to [get in touch](https://www.cbnventures.io/get-in-touch/) with my team.
options:
- label: I agree to the Terms of Use and Privacy Policy
required: true

0 comments on commit 67ecdf5

Please sign in to comment.