Skip to content

Commit 3a7ed56

Browse files
authored
Repo File Sync: 202405 Branch Transition Updates. (#278)
synced local file(s) with [microsoft/mu_devops](https://github.com/microsoft/mu_devops). 🤖: View the [Repo File Sync Configuration File](https://github.com/microsoft/mu_devops/blob/main/.sync/Files.yml) to see how files are synced. --- This PR was created automatically by the [repo-file-sync-action](https://github.com/BetaHuhn/repo-file-sync-action) workflow run [#10532319094](https://github.com/microsoft/mu_devops/actions/runs/10532319094) Signed-off-by: Project Mu UEFI Bot <[email protected]>
1 parent 2a1fc7a commit 3a7ed56

File tree

2 files changed

+55
-27
lines changed

2 files changed

+55
-27
lines changed

.github/pull_request_template.md

+3-26
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,18 @@
1-
# Preface
2-
3-
Please ensure you have read the [contribution docs](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md) prior
4-
to submitting the pull request. In particular,
5-
[pull request guidelines](https://github.com/microsoft/mu/blob/master/CONTRIBUTING.md#pull-request-best-practices).
6-
71
## Description
82

9-
<_Please include a description of the change and why this change was made._>
3+
<_Include a description of the change and why this change was made._>
104

11-
For each item, place an "x" in between `[` and `]` if true. Example: `[x]`.
12-
_(you can also check items in the GitHub UI)_
5+
For details on how to complete to complete these options and their meaning refer to [CONTRIBUTING.md](https://github.com/microsoft/mu/blob/HEAD/CONTRIBUTING.md).
136

147
- [ ] Impacts functionality?
15-
- **Functionality** - Does the change ultimately impact how firmware functions?
16-
- Examples: Add a new library, publish a new PPI, update an algorithm, ...
178
- [ ] Impacts security?
18-
- **Security** - Does the change have a direct security impact on an application,
19-
flow, or firmware?
20-
- Examples: Crypto algorithm change, buffer overflow fix, parameter
21-
validation improvement, ...
229
- [ ] Breaking change?
23-
- **Breaking change** - Will anyone consuming this change experience a break
24-
in build or boot behavior?
25-
- Examples: Add a new library class, move a module to a different repo, call
26-
a function in a new library class in a pre-existing module, ...
2710
- [ ] Includes tests?
28-
- **Tests** - Does the change include any explicit test code?
29-
- Examples: Unit tests, integration tests, robot tests, ...
3011
- [ ] Includes documentation?
31-
- **Documentation** - Does the change contain explicit documentation additions
32-
outside direct code modifications (and comments)?
33-
- Examples: Update readme file, add feature readme file, link to documentation
34-
on an a separate Web page, ...
3512

3613
## How This Was Tested
3714

38-
<_Please describe the test(s) that were run to verify the changes._>
15+
<_Describe the test(s) that were run to verify the changes._>
3916

4017
## Integration Instructions
4118

CONTRIBUTING.md

+52-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ submitted in the issues section.
2121
## Security Vulnerabilities
2222

2323
Please review the repos `Security Policy` but in general every Project Mu repo has `Private vulnerability reporting`
24-
enabled. Please use the security tab to report a potential issue.
24+
enabled. Please use the security tab to report a potential issue.
2525

2626
### Identify Where to Report
2727

@@ -63,6 +63,57 @@ configuration files. To aid maintainers in reviewing your code, we suggest adher
6363
* If the contribution logically be broken up into separate pull requests that independently build and function
6464
successfully, do use multiple pull requests.
6565

66+
#### Pull Request Description Checkboxes
67+
68+
Project Mu pull requests autopopulate a PR description from a template in most repositories. You should:
69+
70+
1. **Replace** this text with an actual descrption:
71+
72+
```txt
73+
<_Include a description of the change and why this change was made._>
74+
```
75+
76+
2. **Remove** this line of instructions so the PR description shows cleanly in release notes:
77+
78+
`"For details on how to complete to complete these options and their meaning refer to [CONTRIBUTING.md](https://github.com/microsoft/mu/blob/HEAD/CONTRIBUTING.md)."`
79+
80+
3. For each checkbox in the PR description, **place an "x"** in between `[` and `]` if true. Example: `[x]`.
81+
_(you can also check items in the GitHub UI)_
82+
83+
* **[] Impacts functionality?**
84+
* **Functionality** - Does the change ultimately impact how firmware functions?
85+
* Examples: Add a new library, publish a new PPI, update an algorithm, ...
86+
* **[] Impacts security?**
87+
* **Security** - Does the change have a direct security impact on an application,
88+
flow, or firmware?
89+
* Examples: Crypto algorithm change, buffer overflow fix, parameter
90+
validation improvement, ...
91+
* **[] Breaking change?**
92+
* **Breaking change** - Will anyone consuming this change experience a break
93+
in build or boot behavior?
94+
* Examples: Add a new library class, move a module to a different repo, call
95+
a function in a new library class in a pre-existing module, ...
96+
* [] **Includes tests?**
97+
* **Tests** - Does the change include any explicit test code?
98+
* Examples: Unit tests, integration tests, robot tests, ...
99+
* [] **Includes documentation?**
100+
* **Documentation** - Does the change contain explicit documentation additions
101+
outside direct code modifications (and comments)?
102+
* Examples: Update readme file, add feature readme file, link to documentation
103+
on an a separate Web page, ...
104+
105+
4. **Replace** this text as instructed:
106+
107+
```txt
108+
<_Describe the test(s) that were run to verify the changes._>
109+
```
110+
111+
5. **Replace** this text as instructed:
112+
113+
```txt
114+
<_Describe how these changes should be integrated. Use N/A if nothing is required._>
115+
```
116+
66117
#### Code Categories
67118

68119
To keep code digestible, you may consider breaking large pull requests into three categories of commits within the pull

0 commit comments

Comments
 (0)