From d18003686f3919a692697ddd11429c000b16de59 Mon Sep 17 00:00:00 2001 From: Travis Plunk Date: Wed, 29 Nov 2017 18:45:57 -0800 Subject: [PATCH 1/7] Update the PR template with the PR submission checklist --- .github/PULL_REQUEST_TEMPLATE.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 684606536ec..7c54946b1d2 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,11 @@ - +## PR Summary From 35118d05a3cf4429bd60f21cff240fdb19620bb4 Mon Sep 17 00:00:00 2001 From: Travis Plunk Date: Wed, 29 Nov 2017 18:48:11 -0800 Subject: [PATCH 2/7] make updating the changelog required --- .github/CONTRIBUTING.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a7491ea8bd9..58e24f6992d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -129,18 +129,18 @@ Additional references: If the changes are related to an existing GitHub issue, please reference the issue in PR description (e.g. ```Fix #11```). See [this][closing-via-message] for more details. -* If the change warrants a note in the [changelog](../CHANGELOG.MD) - either update the changelog in your pull request or - add a comment in the PR description saying that the change may warrant a note in the changelog. - New changes always go into the **Unreleased** section. + +#### Pull request - Change log + +* All PRs must either update the [changelog](../CHANGELOG.MD) in your pull request. + New changes always go into the **Unreleased** section at the top of the changelog. Keeping the changelog up-to-date simplifies the release process for Maintainers. An example (with an associated PR #): ```markdown - Unreleased - ---------- + ## Unreleased - * `Update-Item` now supports `-FriendlyName` (#1234). + * `Update-Item` now supports `-FriendlyName` (#1234, @ExampleUser). ``` * Please use the present tense and imperative mood when describing your changes: From ceaba9c0447098d719c1a747e485c6612eea8be1 Mon Sep 17 00:00:00 2001 From: Travis Plunk Date: Wed, 29 Nov 2017 18:48:30 -0800 Subject: [PATCH 3/7] update the changelog --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index cf08d92cb45..0db81fefe3e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,9 @@ # Changelog +## Unreleased + +- Update the contribution guideline to note that updating the changelog is required. (#TBD) + ## v6.0.0-rc - 2017-11-16 ### Breaking changes From 597f4a45511c6cb2bbe4663d9477a481e4a689a9 Mon Sep 17 00:00:00 2001 From: Travis Plunk Date: Wed, 29 Nov 2017 18:54:58 -0800 Subject: [PATCH 4/7] update PR number --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0db81fefe3e..782e9616edd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,7 +2,7 @@ ## Unreleased -- Update the contribution guideline to note that updating the changelog is required. (#TBD) +- Update the contribution guideline to note that updating the changelog is required. (#5586) ## v6.0.0-rc - 2017-11-16 From a0c7584efd416eff8b204fc7dc82750626df8987 Mon Sep 17 00:00:00 2001 From: Travis Plunk Date: Thu, 30 Nov 2017 12:37:43 -0800 Subject: [PATCH 5/7] Address PR Comments --- .github/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 4431b761d90..9a778e4b4cd 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -13,7 +13,7 @@ # @TravisEz13 @PaulHigin # Area: Documentation -# @joeyaiello @TravisEz13 +.github/ @joeyaiello @TravisEz13 # Area: Test # @JamesWTruher @TravisEz13 @adityapatwardhan From 89c9a8591075ff299bca0fafa4a6e1f1cc9e3921 Mon Sep 17 00:00:00 2001 From: Travis Plunk Date: Thu, 30 Nov 2017 16:23:46 -0800 Subject: [PATCH 6/7] Address PR Comments --- .github/CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 58e24f6992d..6ac13aadac6 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -132,7 +132,7 @@ Additional references: #### Pull request - Change log -* All PRs must either update the [changelog](../CHANGELOG.MD) in your pull request. +* All PRs must update the [changelog](../CHANGELOG.MD) in your pull request. New changes always go into the **Unreleased** section at the top of the changelog. Keeping the changelog up-to-date simplifies the release process for Maintainers. An example (with an associated PR #): @@ -142,6 +142,7 @@ Additional references: * `Update-Item` now supports `-FriendlyName` (#1234, @ExampleUser). ``` + Note: Please add `**Breaking Change**` to the front of the entry in the changelog if the change is [breaking.](#making-breaking-changes) * Please use the present tense and imperative mood when describing your changes: * Instead of "Adding support for Windows Server 2012 R2", write "Add support for Windows Server 2012 R2". From 1477af85cdc5113d5d151769cb3ccee3aec20605 Mon Sep 17 00:00:00 2001 From: Travis Plunk Date: Fri, 1 Dec 2017 16:06:15 -0800 Subject: [PATCH 7/7] Address PR Comments --- .github/PULL_REQUEST_TEMPLATE.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 7c54946b1d2..9556b6b5744 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,11 +1,14 @@ ## PR Checklist +Note: Please mark anything not applicable to this PR `NA`. - [ ] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] Use the present tense and imperative mood when describing your changes - [ ] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] [Update the changelog](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---changelog) -- [ ] User facing [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) (remove if not needed) +- [ ] User facing [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission) - [ ] Issue filed - Issue link: - [ ] [Change is not breaking](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes) +- [ ] [Make sure you've added a new test, if existing tests do not effectively test the code changed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#before-submitting) + - [ ] [Add `[feature]` if the change is significant or affectes feature tests](https://github.com/PowerShell/PowerShell/blob/master/docs/testing-guidelines/testing-guidelines.md#requesting-additional-tests-for-a-pr) ## PR Summary