diff options
author | Michael Kubacki <michael.kubacki@microsoft.com> | 2025-03-06 17:51:59 +0300 |
---|---|---|
committer | Michael Kubacki <michael.kubacki@microsoft.com> | 2025-03-07 21:01:11 +0300 |
commit | 6e0deefba937df648205e907dc6388efb7f3ae79 (patch) | |
tree | c1fb5b924c70c57f841e88e2aa9541c4fc8aeb6e | |
parent | fd56374f2d1f8f6462a61a73dbe8948922c8abdf (diff) | |
download | edk2-platforms-master.tar.xz |
The EDK II Code First process is being revised to align with GitHub.
The actual process changes will be made to the process page on the
TianoCore wiki:
https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-First-Process
These changes:
- Remove the "code first" checkbox from existing forms.
- Add a "code first" issue form that is used to submit issues
tracking code first changes.
The primary template filled in for code first changes is included
with no change from the prior template.
Note: This change is made in edk2-platforms so its issue submission
process is consistent with edk2 but most code first items are
expected to use an edk2 repo issue as their primary tracking issue.
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.yml | 9 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/code_first.yml | 122 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/documentation_request.yml | 9 | ||||
-rw-r--r-- | .github/ISSUE_TEMPLATE/feature_request.yml | 9 |
4 files changed, 122 insertions, 27 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index d4003324f8..73f55e86b1 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -36,15 +36,6 @@ body: - 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:
diff --git a/.github/ISSUE_TEMPLATE/code_first.yml b/.github/ISSUE_TEMPLATE/code_first.yml new file mode 100644 index 0000000000..29b02e4a75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/code_first.yml @@ -0,0 +1,122 @@ +# TianoCore edk2 GitHub Code First Template
+#
+# Copyright (c) Microsoft Corporation.
+# SPDX-License-Identifier: BSD-2-Clause-Patent
+#
+
+name: </> Code First
+description: Code first tracking issue
+title: "[Code First]: <title>"
+labels: ["type:code-first"]
+
+body:
+ - type: markdown
+ attributes:
+ value: |
+ 👋 Only use this issue form for changes following the "code first" process described in [EDK II Code First Process](https://github.com/tianocore/tianocore.github.io/wiki/EDK-II-Code-First-Process).
+
+ **Read that document before filing this issue.**
+
+ - type: textarea
+ id: overview
+ attributes:
+ label: Code First Item Overview
+ description: Provide a brief overview of the overall code first change.
+ validations:
+ required: true
+
+ - type: dropdown
+ id: specs_impacted
+ attributes:
+ label: What specification(s) are directly related?
+ description: |
+ *Select all that apply*
+ multiple: true
+ options:
+ - ACPI
+ - Platform Initialization (PI)
+ - UEFI
+ - UEFI PI Distribution Packaging
+ - UEFI Shell
+ validations:
+ required: true
+
+ - type: markdown
+ attributes:
+ value: |
+ **Specification Draft Template**
+
+ For the template below, the title and complete description of the specification changes must be provided in the
+ specification text along with the name and version of the specification the change applies. The `Status` of the
+ specification change always starts in the `Draft` state and is updated based on feedback from the industry
+ standard forums. The contents of the specification text are required to use the
+ [Creative Commons Attribution 4.0 International](https://spdx.org/licenses/CC-BY-4.0.html) license using a
+ `SPDX-License-Identifier` statement.
+
+ - "Required" sections must be completed.
+ - Include a modified template for each specification impacted (if more than one).
+ - Include a copy of the completed template in a markdown file in the code changes.
+ - If more than one template is completed, place each in a separate markdown file.
+
+ ---
+
+ Template text for reference (using the GitHub flavor of markdown):
+
+ ```markdown
+ # Title: [Must be Filled In]
+
+ ## Status: [Status]
+
+ [Status] must be one of the following:
+ - Draft
+ - Submitted to industry standard forum
+ - Accepted by industry standard forum
+ - Accepted by industry standard forum with modifications
+ - Rejected by industry standard forum
+
+ ## Document: [Title and Version]
+
+ Here are some examples of [Title and Version]:
+ - UEFI Specification Version 2.8
+ - ACPI Specification Version 6.3
+ - UEFI Shell Specification Version 2.2
+ - UEFI Platform Initialization Specification Version 1.7
+ - UEFI Platform Initialization Distribution Packaging Specification Version 1.1
+
+ ## License
+
+ SPDX-License-Identifier: CC-BY-4.0
+
+ ## Submitter: [TianoCore Community](https://www.tianocore.org)
+
+ ## Summary of the change
+
+ Required Section
+
+ ## Benefits of the change
+
+ Required Section
+
+ ## Impact of the change
+
+ Required Section
+
+ ## Detailed description of the change [normative updates]
+
+ Required Section
+
+ ## Special Instructions
+
+ Optional Section
+ ```
+
+ - type: textarea
+ id: anything_else
+ attributes:
+ label: Anything else?
+ description: |
+ Links? References? Anything that will give us more context about the code first change.
+
+ 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/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml index 1512271fdb..bcd473926f 100644 --- a/.github/ISSUE_TEMPLATE/documentation_request.yml +++ b/.github/ISSUE_TEMPLATE/documentation_request.yml @@ -66,15 +66,6 @@ body: 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:
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 539f5c182b..d8e9009564 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -235,15 +235,6 @@ body: 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:
|