|
1 | 1 | <!-- |
2 | 2 | https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository |
3 | 3 | --> |
4 | | - |
5 | | -# Pull Request |
6 | | - |
7 | 4 | ## Description |
8 | | -<!-- |
9 | | -Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. |
10 | | ---> |
11 | | - |
12 | | -<!-- Create a foldable section |
13 | | -<details> |
14 | | -<summary>Example</summary> |
15 | 5 |
|
16 | | -Fixes # (issue) |
17 | | -
|
18 | | -### Example |
19 | | -
|
20 | | -- [x] This is a complete item |
21 | | -- [ ] This is an incomplete item |
22 | | -
|
23 | | -</details> |
24 | | -
|
25 | | - --> |
| 6 | +<!-- Add your description here --> |
26 | 7 |
|
27 | 8 | ## Type of change |
28 | 9 |
|
29 | 10 | <!-- Use the check-boxes [x] on the options that are relevant. --> |
30 | 11 |
|
31 | | -- [ ] Bugfix (non-breaking change which fixes an issue) |
32 | | -- [ ] New feature (non-breaking change which adds functionality) |
33 | | -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) |
34 | | -- [ ] Update to documentation |
35 | | - |
36 | | -## How Has This Been Tested? |
37 | | - |
38 | | -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration |
39 | | - |
40 | | -- [ ] Test A |
41 | | -- [ ] Test B |
42 | | - |
43 | | -**Test Configuration(s)**: |
44 | | - |
45 | | -* Firmware version: |
46 | | -* Hardware: |
47 | | -* Toolchain: |
48 | | -* SDK: |
49 | | - |
50 | | -## Checklist: |
51 | | - |
52 | | -- [ ] My code follows the style guidelines of this project |
53 | | -- [ ] I have performed a self-review of my own code |
54 | | -- [ ] I have commented my code, particularly in hard-to-understand areas |
55 | | -- [ ] I have made corresponding changes to the documentation |
56 | | -- [ ] My changes generate no new warnings |
57 | | -- [ ] I have added tests that prove my fix is effective or that my feature works |
58 | | -- [ ] New and existing unit tests pass locally with my changes |
59 | | -- [ ] Any dependent changes have been merged and published in downstream modules |
60 | | -- [ ] I have checked my code and corrected any misspellings |
| 12 | +- [ ] Doc update |
| 13 | +- [ ] Bugfix |
| 14 | +- [ ] New feature |
| 15 | +- [ ] Breaking change |
61 | 16 |
|
62 | 17 | ## Checklist |
63 | 18 |
|
64 | 19 | <!-- Use the check-boxes [x] on the options that are relevant. --> |
65 | 20 |
|
66 | | -- [ ] I'm sure there are no other open Pull Requests for the same update/change |
67 | | -- [ ] My corresponding pipelines / checks run clean and green without any errors or warnings |
68 | | -- [ ] My code follows the style guidelines of this project |
| 21 | +- [ ] I have performed a self-review of my own code |
69 | 22 | - [ ] I have commented my code, particularly in hard-to-understand areas |
70 | | -- [ ] I have made corresponding changes to the documentation (readme) |
71 | | -- [ ] I did format my code |
72 | | - |
73 | | - |
74 | | -# Pull Request |
75 | | - |
76 | | -<!-- |
77 | | - Thanks for submitting a Pull Request (PR) to this project. |
78 | | - Your contribution to this project is greatly appreciated! |
79 | | -
|
80 | | - TITLE: Please be descriptive not sensationalist. |
81 | | - Prepend the title with the [DscResourceName] if your PR is specific to a DSC resource. |
82 | | - Also prepend with [BREAKING CHANGE] if relevant. |
83 | | - i.e. [BREAKING CHANGE][xFile] Add security descriptor property |
84 | | -
|
85 | | - You may remove this comment block, and the other comment blocks, but please |
86 | | - keep the headers and the task list. |
87 | | - Try to keep your PRs atomic: changes grouped in smallest batch affecting a single logical unit. |
88 | | ---> |
89 | | - |
90 | | -## Pull Request (PR) description |
91 | | - |
92 | | -<!-- |
93 | | - Replace this comment block with a description of your PR to provide context. |
94 | | - Please be describe the intent and link issue where the problem has been discussed. |
95 | | - try to link the issue that it fixes by providing the verb and ref: [fix|close #18] |
96 | | -
|
97 | | - After the description, please concisely list the changes as per keepachangelog.com |
98 | | - This **should** duplicate what you've updated in the changelog file. |
99 | | -
|
100 | | -### Added |
101 | | -- for new features [closes #15] |
102 | | -### Changed |
103 | | -- for changes in existing functionality. |
104 | | -### Deprecated |
105 | | -- for soon-to-be removed features. |
106 | | -### Security |
107 | | -- in case of vulnerabilities. |
108 | | -### Fixed |
109 | | -- for any bug fixes. [fix #52] |
110 | | -### Removed |
111 | | -- for now removed features. |
112 | | ---> |
113 | | - |
114 | | -## Task list |
115 | | - |
116 | | -<!-- |
117 | | - To aid community reviewers in reviewing and merging your PR, please take |
118 | | - the time to run through the below checklist and make sure your PR has |
119 | | - everything updated as required. |
120 | | -
|
121 | | - Change to [x] for each task in the task list that applies to your PR. |
122 | | - For those task that don't apply to you PR, leave those as is. |
123 | | ---> |
124 | | - |
125 | | -- [ ] The PR represents a single logical change. i.e. Cosmetic updates should go in different PRs. |
126 | | -- [ ] Added an entry under the Unreleased section of in the CHANGELOG.md as per [format](https://keepachangelog.com/en/1.0.0/). |
127 | | -- [ ] Local clean build passes without issue or fail tests (`build.ps1 -ResolveDependency`). |
128 | | -- [ ] Resource documentation added/updated in README.md. |
129 | | -- [ ] Resource parameter descriptions added/updated in README.md, schema.mof |
130 | | - and comment-based help. |
131 | | -- [ ] Comment-based help added/updated. |
132 | | -- [ ] Localization strings added/updated in all localization files as appropriate. |
133 | | -- [ ] Examples appropriately added/updated. |
134 | | -- [ ] Unit tests added/updated. See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md). |
135 | | -- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md). |
136 | | -- [ ] New/changed code adheres to [DSC Resource Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md) and [Best Practices](https://github.com/PowerShell/DscResources/blob/master/BestPractices.md). |
0 commit comments