From 0e8e81ed78b1276731907eec1976095eff8bc5f4 Mon Sep 17 00:00:00 2001 From: mitchelbaker-cisa Date: Tue, 11 Feb 2025 20:07:38 +0000 Subject: [PATCH 1/5] revise issue form templates --- .github/ISSUE_TEMPLATE/1-newidea.yaml | 49 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/2-bugreport.yaml | 59 +++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yaml | 1 + 3 files changed, 109 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/1-newidea.yaml create mode 100644 .github/ISSUE_TEMPLATE/2-bugreport.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yaml diff --git a/.github/ISSUE_TEMPLATE/1-newidea.yaml b/.github/ISSUE_TEMPLATE/1-newidea.yaml new file mode 100644 index 0000000000..d0bdc8c1b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-newidea.yaml @@ -0,0 +1,49 @@ +name: "\U0001F4A1 Submit a feature request / idea" +description: Describe an idea, todo, feature, task, improvement, issue, epic, or story +labels: + - enhancement + +body: +- type: checkboxes + attributes: + label: Prerequisites + options: + - label: This issue has an informative and human-readable title. + required: true +- type: textarea + attributes: + label: "\U0001F4A1 Summary" + description: What is the work, as a high-level summary? + placeholder: | + The purpose of this issue is to accomplish x task for y reason... + validations: + required: true +- type: textarea + attributes: + label: Motivation and context + description: Why does this work belong in this project? + placeholder: | + This would be useful because... + validations: + required: true +- type: textarea + attributes: + label: Implementation notes + description: Please provide details for implementation. + placeholder: | + 1. An example for how this would be used + 2. What would this look like + 3. How this would act + 4. Any related work, including links to related issues + validations: + required: true +- type: textarea + attributes: + label: Acceptance criteria (optional) + description: How do we know when this work is done? + placeholder: | + - [ ] The new feature is fully implemented based on x, y, z criteria + - [ ] Additional unit test coverage is added + - [ ] Any other criteria + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2-bugreport.yaml b/.github/ISSUE_TEMPLATE/2-bugreport.yaml new file mode 100644 index 0000000000..09649e6c05 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-bugreport.yaml @@ -0,0 +1,59 @@ +name: "\U0001F41B Bug report" +description: Describe a bug, error, unexpected behavior, or other problem +labels: +- bug + +body: +- type: checkboxes + attributes: + label: Prerequisites + options: + - label: This issue has an informative and human-readable title. + required: true +- type: dropdown + attributes: + label: Operating System + description: Which operating system are you using? + options: + - Windows + - macOS + - Linux + validations: + required: true +- type: input + attributes: + label: PowerShell Version + description: Which PowerShell version are you using? + placeholder: Enter PowerShell version (e.g., 5.1, 7.0) + validations: + required: true +- type: textarea + attributes: + label: "\U0001F41B Summary" + description: What's wrong? Please be specific. + placeholder: Seeing unexpected results in the reports... + validations: + required: true +- type: textarea + attributes: + label: Steps to reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Do this + 2. Then this + validations: + required: true +- type: textarea + attributes: + label: Expected behavior + description: What did you expect to happen that didn't? + validations: + required: true +- type: textarea + attributes: + label: Any helpful log output or screenshots? (optional) + description: | + Paste the results here: + placeholder: "Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in." + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml new file mode 100644 index 0000000000..ec4bb386bc --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -0,0 +1 @@ +blank_issues_enabled: false \ No newline at end of file From 55983d2be679e235838c6fbab24b26a6b3ee09f3 Mon Sep 17 00:00:00 2001 From: mitchelbaker-cisa Date: Tue, 11 Feb 2025 21:25:11 +0000 Subject: [PATCH 2/5] fix linter --- .github/ISSUE_TEMPLATE/1-newidea.yaml | 84 +++++++++---------- .github/ISSUE_TEMPLATE/2-bugreport.yaml | 106 ++++++++++++------------ .github/ISSUE_TEMPLATE/config.yaml | 2 +- 3 files changed, 96 insertions(+), 96 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1-newidea.yaml b/.github/ISSUE_TEMPLATE/1-newidea.yaml index d0bdc8c1b1..81d07e68ac 100644 --- a/.github/ISSUE_TEMPLATE/1-newidea.yaml +++ b/.github/ISSUE_TEMPLATE/1-newidea.yaml @@ -4,46 +4,46 @@ labels: - enhancement body: -- type: checkboxes - attributes: - label: Prerequisites - options: - - label: This issue has an informative and human-readable title. + - type: checkboxes + attributes: + label: Prerequisites + options: + - label: This issue has an informative and human-readable title. + required: true + - type: textarea + attributes: + label: "\U0001F4A1 Summary" + description: What is the work, as a high-level summary? + placeholder: | + The purpose of this issue is to accomplish x task for y reason... + validations: required: true -- type: textarea - attributes: - label: "\U0001F4A1 Summary" - description: What is the work, as a high-level summary? - placeholder: | - The purpose of this issue is to accomplish x task for y reason... - validations: - required: true -- type: textarea - attributes: - label: Motivation and context - description: Why does this work belong in this project? - placeholder: | - This would be useful because... - validations: - required: true -- type: textarea - attributes: - label: Implementation notes - description: Please provide details for implementation. - placeholder: | - 1. An example for how this would be used - 2. What would this look like - 3. How this would act - 4. Any related work, including links to related issues - validations: - required: true -- type: textarea - attributes: - label: Acceptance criteria (optional) - description: How do we know when this work is done? - placeholder: | - - [ ] The new feature is fully implemented based on x, y, z criteria - - [ ] Additional unit test coverage is added - - [ ] Any other criteria - validations: - required: false \ No newline at end of file + - type: textarea + attributes: + label: Motivation and context + description: Why does this work belong in this project? + placeholder: | + This would be useful because... + validations: + required: true + - type: textarea + attributes: + label: Implementation notes + description: Please provide details for implementation. + placeholder: | + 1. An example for how this would be used + 2. What would this look like + 3. How this would act + 4. Any related work, including links to related issues + validations: + required: true + - type: textarea + attributes: + label: Acceptance criteria (optional) + description: How do we know when this work is done? + placeholder: | + - [ ] The new feature is fully implemented based on x, y, z criteria + - [ ] Additional unit test coverage is added + - [ ] Any other criteria + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/2-bugreport.yaml b/.github/ISSUE_TEMPLATE/2-bugreport.yaml index 09649e6c05..e76ff42002 100644 --- a/.github/ISSUE_TEMPLATE/2-bugreport.yaml +++ b/.github/ISSUE_TEMPLATE/2-bugreport.yaml @@ -1,59 +1,59 @@ name: "\U0001F41B Bug report" description: Describe a bug, error, unexpected behavior, or other problem labels: -- bug + - bug body: -- type: checkboxes - attributes: - label: Prerequisites - options: - - label: This issue has an informative and human-readable title. + - type: checkboxes + attributes: + label: Prerequisites + options: + - label: This issue has an informative and human-readable title. + required: true + - type: dropdown + attributes: + label: Operating System + description: Which operating system are you using? + options: + - Windows + - macOS + - Linux + validations: required: true -- type: dropdown - attributes: - label: Operating System - description: Which operating system are you using? - options: - - Windows - - macOS - - Linux - validations: - required: true -- type: input - attributes: - label: PowerShell Version - description: Which PowerShell version are you using? - placeholder: Enter PowerShell version (e.g., 5.1, 7.0) - validations: - required: true -- type: textarea - attributes: - label: "\U0001F41B Summary" - description: What's wrong? Please be specific. - placeholder: Seeing unexpected results in the reports... - validations: - required: true -- type: textarea - attributes: - label: Steps to reproduce - description: Steps to reproduce the behavior. - placeholder: | - 1. Do this - 2. Then this - validations: - required: true -- type: textarea - attributes: - label: Expected behavior - description: What did you expect to happen that didn't? - validations: - required: true -- type: textarea - attributes: - label: Any helpful log output or screenshots? (optional) - description: | - Paste the results here: - placeholder: "Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in." - validations: - required: false \ No newline at end of file + - type: input + attributes: + label: PowerShell Version + description: Which PowerShell version are you using? + placeholder: Enter PowerShell version (e.g., 5.1, 7.0) + validations: + required: true + - type: textarea + attributes: + label: "\U0001F41B Summary" + description: What's wrong? Please be specific. + placeholder: Seeing unexpected results in the reports... + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Do this + 2. Then this + validations: + required: true + - type: textarea + attributes: + label: Expected behavior + description: What did you expect to happen that didn't? + validations: + required: true + - type: textarea + attributes: + label: Any helpful log output or screenshots? (optional) + description: | + Paste the results here: + placeholder: "Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in." + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yaml b/.github/ISSUE_TEMPLATE/config.yaml index ec4bb386bc..3ba13e0cec 100644 --- a/.github/ISSUE_TEMPLATE/config.yaml +++ b/.github/ISSUE_TEMPLATE/config.yaml @@ -1 +1 @@ -blank_issues_enabled: false \ No newline at end of file +blank_issues_enabled: false From edf04dd969179bc09633bf853d9c28c07242c025 Mon Sep 17 00:00:00 2001 From: mitchelbaker-cisa <149098823+mitchelbaker-cisa@users.noreply.github.com> Date: Tue, 11 Feb 2025 13:29:25 -0800 Subject: [PATCH 3/5] Update 1-newidea.yaml --- .github/ISSUE_TEMPLATE/1-newidea.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/1-newidea.yaml b/.github/ISSUE_TEMPLATE/1-newidea.yaml index 81d07e68ac..a4a1b695fc 100644 --- a/.github/ISSUE_TEMPLATE/1-newidea.yaml +++ b/.github/ISSUE_TEMPLATE/1-newidea.yaml @@ -8,7 +8,7 @@ body: attributes: label: Prerequisites options: - - label: This issue has an informative and human-readable title. + - label: This issue has an informative and human-readable title. required: true - type: textarea attributes: From 5c42991acfb9a6eadeeb2faffc41a2f4446a670f Mon Sep 17 00:00:00 2001 From: mitchelbaker-cisa <149098823+mitchelbaker-cisa@users.noreply.github.com> Date: Tue, 11 Feb 2025 13:29:43 -0800 Subject: [PATCH 4/5] Update 1-newidea.yaml --- .github/ISSUE_TEMPLATE/1-newidea.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/1-newidea.yaml b/.github/ISSUE_TEMPLATE/1-newidea.yaml index a4a1b695fc..03a2a17781 100644 --- a/.github/ISSUE_TEMPLATE/1-newidea.yaml +++ b/.github/ISSUE_TEMPLATE/1-newidea.yaml @@ -9,7 +9,7 @@ body: label: Prerequisites options: - label: This issue has an informative and human-readable title. - required: true + required: true - type: textarea attributes: label: "\U0001F4A1 Summary" From d1f1839a72b7bf6675bdb3a25b3fcec98e2fddad Mon Sep 17 00:00:00 2001 From: mitchelbaker-cisa <149098823+mitchelbaker-cisa@users.noreply.github.com> Date: Tue, 11 Feb 2025 13:30:06 -0800 Subject: [PATCH 5/5] Update 2-bugreport.yaml --- .github/ISSUE_TEMPLATE/2-bugreport.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/2-bugreport.yaml b/.github/ISSUE_TEMPLATE/2-bugreport.yaml index e76ff42002..4156c6d4c0 100644 --- a/.github/ISSUE_TEMPLATE/2-bugreport.yaml +++ b/.github/ISSUE_TEMPLATE/2-bugreport.yaml @@ -8,8 +8,8 @@ body: attributes: label: Prerequisites options: - - label: This issue has an informative and human-readable title. - required: true + - label: This issue has an informative and human-readable title. + required: true - type: dropdown attributes: label: Operating System