From 40df344b543f5c9ecdeeec52ecfeea1d7facb4a1 Mon Sep 17 00:00:00 2001 From: Michael Kubacki <michael.kubacki@microsoft.com> Date: Fri, 2 Aug 2024 10:41:39 -0400 Subject: [PATCH] .github: Add GitHub issue templates REF:https://github.com/tianocore/edk2/discussions/5926 Adds GitHub form isssue templates for bugs, documentation requests, and feature requests. These files define the form structure in YAML to be rendered by GitHub in the edk2 repo issues area. See the referenced RFC for additional details. Future changes will add automation tasks described in the RFC. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 229 ++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 6 +- .../ISSUE_TEMPLATE/documentation_request.yml | 87 +++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 151 ++++++++++++ 4 files changed, 468 insertions(+), 5 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_request.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000000..a5ceffb4f0ec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,229 @@ +# TianoCore edk2 GitHub Bug Report Template +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +name: 🐛 Bug Report +description: File a bug report +title: "[Bug]: <title>" +labels: ["type:bug", "state:needs-triage"] + +body: + - type: markdown + attributes: + value: | + 👋 Thanks for taking the time to fill out this bug report! + + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: | + Please search to see if an issue already exists for the bug you encountered. + [Seach existing issues](https://github.com/tianocore/edk2/issues) + options: + - label: I have searched existing issues + required: true + + - type: checkboxes + id: bug_type + attributes: + label: Bug Type + description: | + What type of code does this bug affect? + options: + - label: Firmware + - label: Tool + - label: Unit Test + + - type: checkboxes + id: code_first + attributes: + label: Code first? + description: | + Is this part of a [code first](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-First-Process) change? + options: + - label: "Yes" + + - type: dropdown + id: packages_impacted + attributes: + label: What packages are impacted? + description: | + *Select all that apply* + multiple: true + options: + - ArmPkg + - ArmPlatformPkg + - ArmVirtPkg + - BaseTools + - Build or CI Code + - CryptoPkg + - DynamicTablesPkg + - EmbeddedPkg + - EmulatorPkg + - FatPkg + - FmpDevicePkg + - IntelFsp2Pkg + - IntelFsp2WrapperPkg + - MdeModulePkg + - MdePkg + - NetworkPkg + - OvmfPkg + - PcAtChipsetPkg + - PrmPkg + - RedfishPkg + - SecurityPkg + - ShellPkg + - SignedCapsulePkg + - SourceLevelDebugPkg + - StandaloneMmPkg + - UefiCpuPkg + - UefiPayloadPkg + - UnitTestFrameworkPkg + - Other + validations: + required: true + + - type: dropdown + id: targets_impacted + attributes: + label: Which targets are impacted by this bug? + description: | + *Select all that apply* + multiple: true + options: + - DEBUG + - NO-TARGET + - NOOPT + - RELEASE + + - type: textarea + id: current_behavior + attributes: + label: Current Behavior + description: A concise description of the bug that you're experiencing. + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + + - type: textarea + id: steps_to_reproduce + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + <example> + 1. In this environment (OS, toolchain, platform info, etc.)... + 2. Acquire the source code using these commands... + 3. Build the code using these commands... + 4. Flash the image using these commands... + 5. Boot using this process... + 6. Change option(s)... + 7. See error... + validations: + required: true + + - type: textarea + id: build_environment + attributes: + label: Build Environment + description: | + Examples: + - **OS**: Ubuntu 24.04 or Windows 11... + - **Tool Chain**: GCC5 or VS2022 or CLANGPDB... + value: | + - OS(s): + - Tool Chain(s): + render: markdown + validations: + required: true + + - type: textarea + id: version_info + attributes: + label: Version Information + description: > + What version of this repo is known to reproduce the problem? + + + The problem is assumed to be present from this version and later. If an earlier version is not known other than + the latest commit, indicate that and put the current *edk2/master* commit SHA. + placeholder: | + Commit: <SHA> + -or- + Tag: <Tag> + render: text + validations: + required: true + + - type: markdown + attributes: + value: | + **Urgency Key** + - 🟢 **Low** + - A minor change with little to no important functional impact + - It is not important to fix this in a specific time frame + - 🟡 **Medium** + - An important change with a functional impact + - Will be prioritized above *low* issues in the normal course of development + - 🔥 **High** + - A critical change that has a significant functional impact + - Must be fixed immediately + + - type: dropdown + id: urgency + attributes: + label: Urgency + description: How urgent is it to fix this bug? + multiple: false + options: + - Low + - Medium + - High + validations: + required: true + + - type: dropdown + id: fix_owner + attributes: + label: Are you going to fix this? + description: Indicate if you are going to fix this or requesting someone else fix it. + multiple: false + options: + - I will fix it + - Someone else needs to fix it + validations: + required: true + + - type: dropdown + id: needs_maintainer_feedback + attributes: + label: Do you need maintainer feedback? + description: Indicate if you would like a maintainer to provide feedback on this submission. + multiple: false + options: + - No maintainer feedback needed + - Maintainer feedback requested + validations: + required: true + + - type: textarea + id: anything_else + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering. + + Serial debug logs and/or debugger logs are especially helpful! + + 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.yml b/.github/ISSUE_TEMPLATE/config.yml index 7866c2197aca..dd30f07f3791 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -8,17 +8,13 @@ # SPDX-License-Identifier: BSD-2-Clause-Patent ## -blank_issues_enabled: false contact_links: - - name: Bugs and Feature Requests - url: https://bugzilla.tianocore.org/ - about: Submit bug reports and feature requests here - name: Reporting Security Issues url: https://github.com/tianocore/tianocore.github.io/wiki/Reporting-Security-Issues about: Read the wiki page that describes the process here - name: EDK II Development Mailing List url: https://edk2.groups.io/g/devel - about: Submit code patches and ask questions on the mailing list (devel@edk2.groups.io) + about: Ask questions on the mailing list (devel@edk2.groups.io) - name: EDK II Discussions url: https://github.com/tianocore/edk2/discussions about: You can also reach out on the Discussion section of this repository diff --git a/.github/ISSUE_TEMPLATE/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml new file mode 100644 index 000000000000..86ec4f8fcbcd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_request.yml @@ -0,0 +1,87 @@ +# TianoCore edk2 GitHub Documentation Request Template +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +name: 📖 Documentation Request +description: Request a documentation change +title: "[Documentation]: <title>" +labels: ["type:documentation-request", "state:needs-triage"] + +body: + - type: markdown + attributes: + value: > + 👋 Thanks for taking the time to help us improve our documentation! + + + This form is used to request documentation changes that should be contributed to the **edk2** repository. + + + For example, to improve API documentation in a library class header file or add a markdown file to sit + alongside the code implementation of a particularly complex feature or module. + + + - To file an issue for a TianoCore specification, refer to [these instructions](https://github.com/tianocore-docs/edk2-TemplateSpecification/wiki/TianoCore-Documents-GitBook-Overview) + and reference the specifications In the [TianoCore Docs organization](https://github.com/tianocore-docs). + + - For UEFI specifications, refer to the [UEFI Forum](https://uefi.org/specifications) website. + + - type: markdown + attributes: + value: | + --- + + - type: textarea + id: request_description + attributes: + label: Request Description + description: | + A clear and concise description of what needs to change (*insert images or attachments if relevant*) + validations: + required: true + + - type: dropdown + id: request_owner + attributes: + label: Are you going to make the change? + description: Indicate if you are going to make this change or requesting someone else make it. + multiple: false + options: + - I will make the change + - Someone else needs to make the change + validations: + required: true + + - type: dropdown + id: needs_maintainer_feedback + attributes: + label: Do you need maintainer feedback? + description: Indicate if you would like a maintainer to provide feedback on this submission. + multiple: false + options: + - No maintainer feedback needed + - Maintainer feedback requested + validations: + required: true + + - type: checkboxes + id: code_first + attributes: + label: Code first? + description: | + Is this part of a [code first](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-First-Process) change? + options: + - label: "Yes" + + - type: textarea + id: anything_else + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the request. + + 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/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000000..44c6e36e2cd0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,151 @@ +# TianoCore edk2 GitHub Feature Request Template +# +# Copyright (c) Microsoft Corporation. +# SPDX-License-Identifier: BSD-2-Clause-Patent +# + +name: 🚀 Feature Request +description: Request a feature change +title: "[Feature]: <title>" +labels: ["type:feature-request", "state:needs-triage"] + +body: + - type: markdown + attributes: + value: | + 👋 Thanks for taking the time to help us improve our features! + + - type: textarea + id: feature_overview + attributes: + label: Feature Overview + description: Provide a high-level summary of your feature request. + validations: + required: true + + - type: textarea + id: solution_overview + attributes: + label: Solution Overview + description: Give a clear and concise description of what you want to happen. + validations: + required: true + + - type: textarea + id: alternatives_considered + attributes: + label: Alternatives Considered + description: Describe alternatives you've considered. + validations: + required: false + + - type: dropdown + id: packages_impacted + attributes: + label: What packages are impacted? + description: | + *Select all that apply* + multiple: true + options: + - ArmPkg + - ArmPlatformPkg + - ArmVirtPkg + - BaseTools + - Build or CI Code + - CryptoPkg + - DynamicTablesPkg + - EmbeddedPkg + - EmulatorPkg + - FatPkg + - FmpDevicePkg + - IntelFsp2Pkg + - IntelFsp2WrapperPkg + - MdeModulePkg + - MdePkg + - NetworkPkg + - OvmfPkg + - PcAtChipsetPkg + - PrmPkg + - RedfishPkg + - SecurityPkg + - ShellPkg + - SignedCapsulePkg + - SourceLevelDebugPkg + - StandaloneMmPkg + - UefiCpuPkg + - UefiPayloadPkg + - UnitTestFrameworkPkg + - Other + validations: + required: true + + - type: markdown + attributes: + value: | + **Urgency Key** + - 🟢 **Low** + - A minor enhancement + - It is not important to address this request in a specific time frame + - 🟡 **Medium** + - An important enhancement + - Will be prioritized above *low* requests in the normal course of development + - 🔥 **High** + - A critical enhancement with significant value + - Should be prioritized above *low* and *medium* requests + + - type: dropdown + id: urgency + attributes: + label: Urgency + description: How urgent is it to resolve this feature request? + multiple: false + options: + - Low + - Medium + - High + validations: + required: true + + - type: dropdown + id: request_owner + attributes: + label: Are you going to implement the feature request? + description: Indicate if you are going to do the work to close this feature request. + multiple: false + options: + - I will implement the feature + - Someone else needs to implement the feature + validations: + required: true + + - type: dropdown + id: needs_maintainer_feedback + attributes: + label: Do you need maintainer feedback? + description: Indicate if you would like a maintainer to provide feedback on this submission. + multiple: false + options: + - No maintainer feedback needed + - Maintainer feedback requested + validations: + required: true + + - type: checkboxes + id: code_first + attributes: + label: Code first? + description: | + Is this part of a [code first](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-First-Process) change? + options: + - label: "Yes" + + - type: textarea + id: anything_else + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the feature you are requesting. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false