|
| 1 | +# TianoCore edk2 GitHub Bug Report Template |
| 2 | +# |
| 3 | +# Copyright (c) Microsoft Corporation. |
| 4 | +# SPDX-License-Identifier: BSD-2-Clause-Patent |
| 5 | +# |
| 6 | + |
| 7 | +name: 🐛 Bug Report |
| 8 | +description: File a bug report |
| 9 | +title: "[Bug]: <title>" |
| 10 | +labels: ["type:bug", "state:needs-triage"] |
| 11 | + |
| 12 | +body: |
| 13 | + - type: markdown |
| 14 | + attributes: |
| 15 | + value: | |
| 16 | + 👋 Thanks for taking the time to fill out this bug report! |
| 17 | +
|
| 18 | + - type: checkboxes |
| 19 | + attributes: |
| 20 | + label: Is there an existing issue for this? |
| 21 | + description: | |
| 22 | + Please search to see if an issue already exists for the bug you encountered. |
| 23 | + [Seach existing issues](https://github.com/tianocore/edk2/issues) |
| 24 | + options: |
| 25 | + - label: I have searched existing issues |
| 26 | + required: true |
| 27 | + |
| 28 | + - type: checkboxes |
| 29 | + id: bug_type |
| 30 | + attributes: |
| 31 | + label: Bug Type |
| 32 | + description: | |
| 33 | + What type of code does this bug affect? |
| 34 | + options: |
| 35 | + - label: Firmware |
| 36 | + - label: Tool |
| 37 | + - label: Unit Test |
| 38 | + |
| 39 | + - type: checkboxes |
| 40 | + id: code_first |
| 41 | + attributes: |
| 42 | + label: Code first? |
| 43 | + description: | |
| 44 | + Is this part of a [code first](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-First-Process) change? |
| 45 | + options: |
| 46 | + - label: "Yes" |
| 47 | + |
| 48 | + - type: dropdown |
| 49 | + id: packages_impacted |
| 50 | + attributes: |
| 51 | + label: What packages are impacted? |
| 52 | + description: | |
| 53 | + *Select all that apply* |
| 54 | + multiple: true |
| 55 | + options: |
| 56 | + - ArmPkg |
| 57 | + - ArmPlatformPkg |
| 58 | + - ArmVirtPkg |
| 59 | + - BaseTools |
| 60 | + - Build or CI Code |
| 61 | + - CryptoPkg |
| 62 | + - DynamicTablesPkg |
| 63 | + - EmbeddedPkg |
| 64 | + - EmulatorPkg |
| 65 | + - FatPkg |
| 66 | + - FmpDevicePkg |
| 67 | + - IntelFsp2Pkg |
| 68 | + - IntelFsp2WrapperPkg |
| 69 | + - MdeModulePkg |
| 70 | + - MdePkg |
| 71 | + - NetworkPkg |
| 72 | + - OvmfPkg |
| 73 | + - PcAtChipsetPkg |
| 74 | + - PrmPkg |
| 75 | + - RedfishPkg |
| 76 | + - SecurityPkg |
| 77 | + - ShellPkg |
| 78 | + - SignedCapsulePkg |
| 79 | + - SourceLevelDebugPkg |
| 80 | + - StandaloneMmPkg |
| 81 | + - UefiCpuPkg |
| 82 | + - UefiPayloadPkg |
| 83 | + - UnitTestFrameworkPkg |
| 84 | + - Other |
| 85 | + validations: |
| 86 | + required: true |
| 87 | + |
| 88 | + - type: dropdown |
| 89 | + id: targets_impacted |
| 90 | + attributes: |
| 91 | + label: Which targets are impacted by this bug? |
| 92 | + description: | |
| 93 | + *Select all that apply* |
| 94 | + multiple: true |
| 95 | + options: |
| 96 | + - DEBUG |
| 97 | + - NO-TARGET |
| 98 | + - NOOPT |
| 99 | + - RELEASE |
| 100 | + |
| 101 | + - type: textarea |
| 102 | + id: current_behavior |
| 103 | + attributes: |
| 104 | + label: Current Behavior |
| 105 | + description: A concise description of the bug that you're experiencing. |
| 106 | + validations: |
| 107 | + required: true |
| 108 | + |
| 109 | + - type: textarea |
| 110 | + id: expected_behavior |
| 111 | + attributes: |
| 112 | + label: Expected Behavior |
| 113 | + description: A concise description of what you expected to happen. |
| 114 | + validations: |
| 115 | + required: true |
| 116 | + |
| 117 | + - type: textarea |
| 118 | + id: steps_to_reproduce |
| 119 | + attributes: |
| 120 | + label: Steps To Reproduce |
| 121 | + description: Steps to reproduce the behavior. |
| 122 | + placeholder: | |
| 123 | + <example> |
| 124 | + 1. In this environment (OS, toolchain, platform info, etc.)... |
| 125 | + 2. Acquire the source code using these commands... |
| 126 | + 3. Build the code using these commands... |
| 127 | + 4. Flash the image using these commands... |
| 128 | + 5. Boot using this process... |
| 129 | + 6. Change option(s)... |
| 130 | + 7. See error... |
| 131 | + validations: |
| 132 | + required: true |
| 133 | + |
| 134 | + - type: textarea |
| 135 | + id: build_environment |
| 136 | + attributes: |
| 137 | + label: Build Environment |
| 138 | + description: | |
| 139 | + Examples: |
| 140 | + - **OS**: Ubuntu 24.04 or Windows 11... |
| 141 | + - **Tool Chain**: GCC5 or VS2022 or CLANGPDB... |
| 142 | + value: | |
| 143 | + - OS(s): |
| 144 | + - Tool Chain(s): |
| 145 | + render: markdown |
| 146 | + validations: |
| 147 | + required: true |
| 148 | + |
| 149 | + - type: textarea |
| 150 | + id: version_info |
| 151 | + attributes: |
| 152 | + label: Version Information |
| 153 | + description: > |
| 154 | + What version of this repo is known to reproduce the problem? |
| 155 | +
|
| 156 | +
|
| 157 | + The problem is assumed to be present from this version and later. If an earlier version is not known other than |
| 158 | + the latest commit, indicate that and put the current *edk2/master* commit SHA. |
| 159 | + placeholder: | |
| 160 | + Commit: <SHA> |
| 161 | + -or- |
| 162 | + Tag: <Tag> |
| 163 | + render: text |
| 164 | + validations: |
| 165 | + required: true |
| 166 | + |
| 167 | + - type: markdown |
| 168 | + attributes: |
| 169 | + value: | |
| 170 | + **Urgency Key** |
| 171 | + - 🟢 **Low** |
| 172 | + - A minor change with little to no important functional impact |
| 173 | + - It is not important to fix this in a specific time frame |
| 174 | + - 🟡 **Medium** |
| 175 | + - An important change with a functional impact |
| 176 | + - Will be prioritized above *low* issues in the normal course of development |
| 177 | + - 🔥 **High** |
| 178 | + - A critical change that has a significant functional impact |
| 179 | + - Must be fixed immediately |
| 180 | +
|
| 181 | + - type: dropdown |
| 182 | + id: urgency |
| 183 | + attributes: |
| 184 | + label: Urgency |
| 185 | + description: How urgent is it to fix this bug? |
| 186 | + multiple: false |
| 187 | + options: |
| 188 | + - Low |
| 189 | + - Medium |
| 190 | + - High |
| 191 | + validations: |
| 192 | + required: true |
| 193 | + |
| 194 | + - type: dropdown |
| 195 | + id: fix_owner |
| 196 | + attributes: |
| 197 | + label: Are you going to fix this? |
| 198 | + description: Indicate if you are going to fix this or requesting someone else fix it. |
| 199 | + multiple: false |
| 200 | + options: |
| 201 | + - I will fix it |
| 202 | + - Someone else needs to fix it |
| 203 | + validations: |
| 204 | + required: true |
| 205 | + |
| 206 | + - type: dropdown |
| 207 | + id: needs_maintainer_feedback |
| 208 | + attributes: |
| 209 | + label: Do you need maintainer feedback? |
| 210 | + description: Indicate if you would like a maintainer to provide feedback on this submission. |
| 211 | + multiple: false |
| 212 | + options: |
| 213 | + - No maintainer feedback needed |
| 214 | + - Maintainer feedback requested |
| 215 | + validations: |
| 216 | + required: true |
| 217 | + |
| 218 | + - type: textarea |
| 219 | + id: anything_else |
| 220 | + attributes: |
| 221 | + label: Anything else? |
| 222 | + description: | |
| 223 | + Links? References? Anything that will give us more context about the issue you are encountering. |
| 224 | +
|
| 225 | + Serial debug logs and/or debugger logs are especially helpful! |
| 226 | +
|
| 227 | + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. |
| 228 | + validations: |
| 229 | + required: false |
0 commit comments