Skip to content

Commit dfd3f78

Browse files
Update Pull Request Template for Clarity and Consistency closes #52
Refine the PR template by adding examples for clarity and updating the task list for consistency. This ensures contributors have clear guidance on what is expected when submitting a pull request, enhancing the overall contribution process for Pester Help Tests. Thank you!
1 parent bce4bef commit dfd3f78

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@
2323
2424
After the description, please concisely list the changes as per keepachangelog.com
2525
This **should** duplicate what you've updated in the changelog file.
26+
27+
for example:
2628
2729
### Added
2830
- for new features [closes #15]
@@ -51,13 +53,9 @@
5153

5254
- [ ] The PR represents a single logical change. i.e. Cosmetic updates should go in different PRs.
5355
- [ ] Added an entry under the Unreleased section of in the CHANGELOG.md as per [format](https://keepachangelog.com/en/1.0.0/).
54-
- [ ] Local clean build passes without issue or fail tests (`build.ps1 -ResolveDependency`).
55-
- [ ] Resource documentation added/updated in README.md.
56-
- [ ] Resource parameter descriptions added/updated in README.md, schema.mof
57-
and comment-based help.
56+
- [ ] Local clean build passes without issue or fail tests (`build.ps1 -ResolveDependency -Tasks build, test`).
5857
- [ ] Comment-based help added/updated.
59-
- [ ] Localization strings added/updated in all localization files as appropriate.
6058
- [ ] Examples appropriately added/updated.
61-
- [ ] Unit tests added/updated. See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
62-
- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
63-
- [ ] 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).
59+
- [ ] Unit tests added/updated..
60+
- [ ] Integration tests added/updated (where possible).
61+
- [ ] Documentation added/updated (where applicable).

0 commit comments

Comments
 (0)