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 diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a7491ea8bd9..6ac13aadac6 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -129,19 +129,20 @@ 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 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). ``` + 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". diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 684606536ec..9556b6b5744 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,14 @@ - +## PR Summary diff --git a/CHANGELOG.md b/CHANGELOG.md index cf08d92cb45..782e9616edd 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. (#5586) + ## v6.0.0-rc - 2017-11-16 ### Breaking changes