From 5457271d6e840ba11c41118528b6c5f6f87effad Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Tue, 12 Aug 2025 14:52:18 -0700 Subject: [PATCH 1/3] Add issue templates This adds templates based on other Quantumlib projects. This follows the practices of other projects in providing a more guided workflow for people to report bugs, ask questions, or take note of tasks to be done. --- .github/ISSUE_TEMPLATE/1-bug-report.yml | 37 +++++++++++++++++ .github/ISSUE_TEMPLATE/2-feature-request.yml | 43 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/3-task.yml | 34 ++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 1 + 4 files changed, 115 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/2-feature-request.yml create mode 100644 .github/ISSUE_TEMPLATE/3-task.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml new file mode 100644 index 00000000..83df0995 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-bug-report.yml @@ -0,0 +1,37 @@ +name: Bug report +description: Report a problem with this software or project +type: Bug +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this bug report! + + - type: textarea + attributes: + label: Describe the issue + description: >- + Please explain clearly and in detail what the issue is. What led up + to it, or how did you encounter it? + validations: + required: true + + - type: input + attributes: + label: What version of the software are you using? + validations: + required: false + + - type: textarea + attributes: + label: How can the issue be reproduced? + description: >- + Explain in a step-by-step fashion what someone else would need to + do in order to reproduce the issue. If possible, include literal + examples of commands or code using [Markdown fenced code + blocks](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks). + For long output, paste the text into [collapsed + sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections) + or attach text files. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml new file mode 100644 index 00000000..8d165df7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml @@ -0,0 +1,43 @@ +name: Feature request +description: Request a new feature or change +type: Enhancement +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request form! + + - type: textarea + attributes: + label: Is your feature request related to a use case or problem? + description: >- + Please tell us the context of your request. Is it to help you do + something that you currently cannot due to limitations in the software, + or is it an idea for an enhancement or new functionality, or something + else? + validations: + required: true + + - type: textarea + attributes: + label: What solution or approach do you envision? + description: >- + If you have ideas or preferences for the solution, you can let us know + here. If you are aware of other similar or related work, please let us + know about it here. + validations: + required: false + + - type: dropdown + attributes: + label: How urgent is this for you? + description: >- + Please choose from among the following options. If the lack of this + feature is blocking important work, please choose from among P0–P2. + options: + - P0 – needed no later than a week + - P1 – needed by the next release + - P2 – needed within two quarters + - P3 – not blocked; it's an idea + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/3-task.yml b/.github/ISSUE_TEMPLATE/3-task.yml new file mode 100644 index 00000000..12af4357 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-task.yml @@ -0,0 +1,34 @@ +name: Task +description: Describe a task that needs to be done +type: Task +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this feature request form! + + - type: textarea + attributes: + label: What is the task? + validations: + required: true + + - type: textarea + attributes: + label: (Optional) Do you have ideas or preferences for the approach? + validations: + required: false + + - type: dropdown + attributes: + label: How urgent is this for you? + description: >- + Please choose from among the following options. If the lack of this + feature is blocking important work, please choose from among P0–P2. + options: + - P0 – needed no later than a week + - P1 – needed by the next release + - P2 – needed within two quarters + - P3 – not blocked; it's an idea + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..0086358d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true From cb99d918e252ae1f6f2722b831839df46da22249 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Wed, 13 Aug 2025 16:10:39 -0700 Subject: [PATCH 2/3] Fix copy-paste error The sentence should refer to task, not feature request. (Thanks to @lalehb for spotting it.) --- .github/ISSUE_TEMPLATE/3-task.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3-task.yml b/.github/ISSUE_TEMPLATE/3-task.yml index 12af4357..3cdb2c0d 100644 --- a/.github/ISSUE_TEMPLATE/3-task.yml +++ b/.github/ISSUE_TEMPLATE/3-task.yml @@ -5,7 +5,7 @@ body: - type: markdown attributes: value: | - Thank you for taking the time to fill out this feature request form! + Thank you for taking the time to fill out this task form! - type: textarea attributes: From b806a88ccb9dd3f9e49486f195e4c94a6b02aec6 Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Wed, 13 Aug 2025 16:11:06 -0700 Subject: [PATCH 3/3] Improve the text a little bit --- .github/ISSUE_TEMPLATE/2-feature-request.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml index 8d165df7..86dfddd7 100644 --- a/.github/ISSUE_TEMPLATE/2-feature-request.yml +++ b/.github/ISSUE_TEMPLATE/2-feature-request.yml @@ -9,7 +9,7 @@ body: - type: textarea attributes: - label: Is your feature request related to a use case or problem? + label: What is your feature request? description: >- Please tell us the context of your request. Is it to help you do something that you currently cannot due to limitations in the software, @@ -23,8 +23,8 @@ body: label: What solution or approach do you envision? description: >- If you have ideas or preferences for the solution, you can let us know - here. If you are aware of other similar or related work, please let us - know about it here. + here. If you are aware of other similar or related work, please also + let us know about it here. validations: required: false