From fe6d9ff89a91f0c39bc020db00243729d078d496 Mon Sep 17 00:00:00 2001 From: Bingran Hu Date: Wed, 15 Jan 2025 17:12:21 -0500 Subject: [PATCH 1/4] add issue templates --- .github/ISSUE_TEMPLATE/bug-report.yaml | 39 +++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 1 + .github/ISSUE_TEMPLATE/feature-request.yaml | 21 +++++++++++ 3 files changed, 61 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml create mode 100644 .github/ISSUE_TEMPLATE/feature-request.yaml diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml new file mode 100644 index 00000000..a03d6371 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -0,0 +1,39 @@ +name: "Bug Report" +description: "Report software deficiencies" +labels: ["bug"] +body: + - type: "markdown" + attributes: + value: | + Use this form to report any functional or performance bugs you've found in the software. + Be sure to check if your [issue](https://github.com/y-scope/ystdlib-cpp/issues) has already + been reported. + - type: "textarea" + attributes: + label: "Bug" + description: "Describe what's wrong and if applicable, what you expected instead." + validations: + required: true + + - type: "input" + attributes: + label: "ystdlib-cpp version" + description: "The release version number or development commit hash that has the bug." + placeholder: "Version number or commit hash" + validations: + required: true + + - type: "textarea" + attributes: + label: "Environment" + description: "The environment in which you're running ystdlib-cpp." + placeholder: "OS version, Docker version, etc." + validations: + required: true + + - type: "textarea" + attributes: + label: "Reproduction steps" + description: "List each step required to reproduce the bug." + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 00000000..0086358d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml new file mode 100644 index 00000000..a49b055d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -0,0 +1,21 @@ +name: "Feature/Change Request" +description: "Request a feature or change" +labels: ["enhancement"] +body: + - type: "markdown" + attributes: + value: | + Use this form to request a feature/change in the software, or the project as a whole. + - type: "textarea" + attributes: + label: "Request" + description: "Describe your request and why it's important." + validations: + required: true + + - type: "textarea" + attributes: + label: "Possible implementation" + description: "Describe any implementations you have in mind." + validations: + required: true From da1e3233176c91543417c4798fe976ba6e62202c Mon Sep 17 00:00:00 2001 From: Bingran Hu Date: Wed, 15 Jan 2025 18:16:39 -0500 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: davidlion --- .github/ISSUE_TEMPLATE/bug-report.yaml | 4 +++- .github/ISSUE_TEMPLATE/feature-request.yaml | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index a03d6371..49e00847 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -6,9 +6,11 @@ body: attributes: value: | Use this form to report any functional or performance bugs you've found in the software. + Be sure to check if your [issue](https://github.com/y-scope/ystdlib-cpp/issues) has already been reported. - - type: "textarea" + + - type: "textarea" attributes: label: "Bug" description: "Describe what's wrong and if applicable, what you expected instead." diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index a49b055d..8cd7d922 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -6,6 +6,7 @@ body: attributes: value: | Use this form to request a feature/change in the software, or the project as a whole. + - type: "textarea" attributes: label: "Request" From f20a66425fa6040f7943e1245f1fa6963586ad49 Mon Sep 17 00:00:00 2001 From: Bingran Hu Date: Wed, 15 Jan 2025 18:17:33 -0500 Subject: [PATCH 3/4] Update indentation --- .github/ISSUE_TEMPLATE/bug-report.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug-report.yaml b/.github/ISSUE_TEMPLATE/bug-report.yaml index 49e00847..91e364cc 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.yaml +++ b/.github/ISSUE_TEMPLATE/bug-report.yaml @@ -10,7 +10,7 @@ body: Be sure to check if your [issue](https://github.com/y-scope/ystdlib-cpp/issues) has already been reported. - - type: "textarea" + - type: "textarea" attributes: label: "Bug" description: "Describe what's wrong and if applicable, what you expected instead." From 601614a9242ca582c8f4dfd8531af85efe10a38f Mon Sep 17 00:00:00 2001 From: Bingran Hu Date: Wed, 15 Jan 2025 19:34:43 -0500 Subject: [PATCH 4/4] Update .github/ISSUE_TEMPLATE/feature-request.yaml Co-authored-by: davidlion --- .github/ISSUE_TEMPLATE/feature-request.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature-request.yaml b/.github/ISSUE_TEMPLATE/feature-request.yaml index 8cd7d922..a49b055d 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.yaml +++ b/.github/ISSUE_TEMPLATE/feature-request.yaml @@ -6,7 +6,6 @@ body: attributes: value: | Use this form to request a feature/change in the software, or the project as a whole. - - type: "textarea" attributes: label: "Request"