diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7b84ac775f..5a677a5a6a 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,30 +1,53 @@ +#### Pull Request (PR) description + -**Pull Request (PR) description** - -**This Pull Request (PR) fixes the following issues:** - +#### This Pull Request (PR) fixes the following issues + -**Task list:** +#### Task list -- [ ] Change details added to Unreleased section of CHANGELOG.md? -- [ ] Added/updated documentation, comment-based help and descriptions in .schema.mof files where appropriate? -- [ ] Examples appropriately updated? -- [ ] New/changed code adheres to [Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md)? -- [ ] [Unit and (optional) Integration tests](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md) created/updated where possible? +- [ ] Added an entry under the Unreleased section in the CHANGELOG.md? Entry + should say what was changed, and how that affects users (if applicable). +- [ ] Resource documentation added/updated in README.md? +- [ ] Resource parameter descriptions added/updated in README.md, schema.mof + and comment-based help? +- [ ] Comment-based help added/updated? +- [ ] Localization strings added/updated in all localization files as appropriate? +- [ ] Examples appropriately added/updated? +- [ ] Unit tests added/updated? + See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md). +- [ ] Integration tests added/updated (where possible)? + See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md). +- [ ] 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)? diff --git a/CHANGELOG.md b/CHANGELOG.md index 546593e177..8a71d6172b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## Unreleased +- Changes to SqlServerDsc + - Updated the PULL_REQUEST_TEMPLATE with an improved task list and modified + some text to be clearer + ([issue #973](https://github.com/PowerShell/SqlServerDsc/issues/973)). - Changes to SqlServerLogin - Fix password test fails for nativ sql users ([issue #1048](https://github.com/PowerShell/SqlServerDsc/issues/1048)). - Changes to SqlSetup