From 1c0165c23045ff2f927bbcbf0273d1cb45c86a25 Mon Sep 17 00:00:00 2001 From: uefibot Date: Sat, 21 Sep 2024 09:03:59 +0000 Subject: [PATCH] Repo File Sync: synced file(s) with microsoft/mu_devops Signed-off-by: Project Mu UEFI Bot --- .github/pull_request_template.md | 29 ++------------- .github/release-draft-config-n-1.yml | 2 +- .github/release-draft-config-n.yml | 2 +- .github/workflows/release-draft.yml | 2 +- CONTRIBUTING.md | 53 +++++++++++++++++++++++++++- 5 files changed, 58 insertions(+), 30 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 0f216b6d50..eb455e3452 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,41 +1,18 @@ -# Preface - -Please ensure you have read the [contribution docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior -to submitting the pull request. In particular, -[pull request guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices). - ## Description -<_Please include a description of the change and why this change was made._> +<_Include a description of the change and why this change was made._> -For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. -_(you can also check items in the GitHub UI)_ +For details on how to complete these options and their meaning refer to [CONTRIBUTING.md](https://github.com/microsoft/mu/blob/HEAD/CONTRIBUTING.md). - [ ] Impacts functionality? - - **Functionality** - Does the change ultimately impact how firmware functions? - - Examples: Add a new library, publish a new PPI, update an algorithm, ... - [ ] Impacts security? - - **Security** - Does the change have a direct security impact on an application, - flow, or firmware? - - Examples: Crypto algorithm change, buffer overflow fix, parameter - validation improvement, ... - [ ] Breaking change? - - **Breaking change** - Will anyone consuming this change experience a break - in build or boot behavior? - - Examples: Add a new library class, move a module to a different repo, call - a function in a new library class in a pre-existing module, ... - [ ] Includes tests? - - **Tests** - Does the change include any explicit test code? - - Examples: Unit tests, integration tests, robot tests, ... - [ ] Includes documentation? - - **Documentation** - Does the change contain explicit documentation additions - outside direct code modifications (and comments)? - - Examples: Update readme file, add feature readme file, link to documentation - on an a separate Web page, ... ## How This Was Tested -<_Please describe the test(s) that were run to verify the changes._> +<_Describe the test(s) that were run to verify the changes._> ## Integration Instructions diff --git a/.github/release-draft-config-n-1.yml b/.github/release-draft-config-n-1.yml index 8609c62bb9..fcf38acfbd 100644 --- a/.github/release-draft-config-n-1.yml +++ b/.github/release-draft-config-n-1.yml @@ -20,7 +20,7 @@ name-template: 'v$RESOLVED_VERSION' tag-template: 'v$RESOLVED_VERSION' -commitish: refs/heads/release/202302 +commitish: refs/heads/release/202311 filter-by-commitish: true template: | diff --git a/.github/release-draft-config-n.yml b/.github/release-draft-config-n.yml index fcf38acfbd..b4fd801fee 100644 --- a/.github/release-draft-config-n.yml +++ b/.github/release-draft-config-n.yml @@ -20,7 +20,7 @@ name-template: 'v$RESOLVED_VERSION' tag-template: 'v$RESOLVED_VERSION' -commitish: refs/heads/release/202311 +commitish: refs/heads/release/202405 filter-by-commitish: true template: | diff --git a/.github/workflows/release-draft.yml b/.github/workflows/release-draft.yml index 94e45e70f0..27517df9f0 100644 --- a/.github/workflows/release-draft.yml +++ b/.github/workflows/release-draft.yml @@ -23,7 +23,7 @@ name: Update Release Draft on: push: branches: - - release/202311 + - release/202405 jobs: draft: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c6ff888b87..2199e97489 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ submitted in the issues section. ## Security Vulnerabilities Please review the repos `Security Policy` but in general every Project Mu repo has `Private vulnerability reporting` -enabled. Please use the security tab to report a potential issue. +enabled. Please use the security tab to report a potential issue. ### Identify Where to Report @@ -63,6 +63,57 @@ configuration files. To aid maintainers in reviewing your code, we suggest adher * If the contribution logically be broken up into separate pull requests that independently build and function successfully, do use multiple pull requests. +#### Pull Request Description Checkboxes + +Project Mu pull requests autopopulate a PR description from a template in most repositories. You should: + +1. **Replace** this text with an actual descrption: + + ```txt + <_Include a description of the change and why this change was made._> + ``` + +2. **Remove** this line of instructions so the PR description shows cleanly in release notes: + + `"For details on how to complete these options and their meaning refer to [CONTRIBUTING.md](https://github.com/microsoft/mu/blob/HEAD/CONTRIBUTING.md)."` + +3. For each checkbox in the PR description, **place an "x"** in between `[` and `]` if true. Example: `[x]`. + _(you can also check items in the GitHub UI)_ + + * **[] Impacts functionality?** + * **Functionality** - Does the change ultimately impact how firmware functions? + * Examples: Add a new library, publish a new PPI, update an algorithm, ... + * **[] Impacts security?** + * **Security** - Does the change have a direct security impact on an application, + flow, or firmware? + * Examples: Crypto algorithm change, buffer overflow fix, parameter + validation improvement, ... + * **[] Breaking change?** + * **Breaking change** - Will anyone consuming this change experience a break + in build or boot behavior? + * Examples: Add a new library class, move a module to a different repo, call + a function in a new library class in a pre-existing module, ... + * [] **Includes tests?** + * **Tests** - Does the change include any explicit test code? + * Examples: Unit tests, integration tests, robot tests, ... + * [] **Includes documentation?** + * **Documentation** - Does the change contain explicit documentation additions + outside direct code modifications (and comments)? + * Examples: Update readme file, add feature readme file, link to documentation + on an a separate Web page, ... + +4. **Replace** this text as instructed: + + ```txt + <_Describe the test(s) that were run to verify the changes._> + ``` + +5. **Replace** this text as instructed: + + ```txt + <_Describe how these changes should be integrated. Use N/A if nothing is required._> + ``` + #### Code Categories To keep code digestible, you may consider breaking large pull requests into three categories of commits within the pull