microsoft/mu_feature_ffa
Publicmirrored fromhttps://github.com/microsoft/mu_feature_ffaAvailable
.github/pull_request_template.md
42lines · modecode
| 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 | |
| 7 | ## Description |
| 8 | |
| 9 | <_Please include a description of the change and why this change was made._> |
| 10 | |
| 11 | For each item, place an "x" in between `[` and `]` if true. Example: `[x]`. |
| 12 | _(you can also check items in the GitHub UI)_ |
| 13 | |
| 14 | - [ ] 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, ... |
| 17 | - [ ] 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, ... |
| 22 | - [ ] 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, ... |
| 27 | - [ ] Includes tests? |
| 28 | - **Tests** - Does the change include any explicit test code? |
| 29 | - Examples: Unit tests, integration tests, robot tests, ... |
| 30 | - [ ] 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, ... |
| 35 | |
| 36 | ## How This Was Tested |
| 37 | |
| 38 | <_Please describe the test(s) that were run to verify the changes._> |
| 39 | |
| 40 | ## Integration Instructions |
| 41 | |
| 42 | <_Describe how these changes should be integrated. Use N/A if nothing is required._> |
| 43 | |