Skip to content

Commit 81bb815

Browse files
authored
Elaborate on check list items in PR template (#101)
The pull request template has a number of items contributors can check to classify their changes. This commit updates the template to give more details about the types of changes that impact the checkboxes along with some examples. Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
1 parent 4eb4705 commit 81bb815

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

.sync/github_templates/pull_requests/pull_request_template.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,26 @@ For each item, place an "x" in between `[` and `]` if true. Example: `[x]`.
1212
_(you can also check items in the GitHub UI)_
1313

1414
- [ ] 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, ...
1517
- [ ] 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, ...
1622
- [ ] 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, ...
1727
- [ ] Includes tests?
28+
- **Tests** - Does the change include any explicit test code?
29+
- Examples: Unit tests, integration tests, robot tests, ...
1830
- [ ] 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, ...
1935

2036
## How This Was Tested
2137

0 commit comments

Comments
 (0)