Skip to content

Commit 7cb76f5

Browse files
committed
contribution guidelines: change to say updating changelog is required (#5586)
- Update contribution guidelines to make updating the changelog required - add a checklist to PR template Comment by @SteveL-MSFT : > Everyone should understand that we are always open to feedback and nothing is set in stone. Based on a team discussion, one of the biggest costs for a release is creating the ChangeLog hence updating this document to push it to the contributor most aware of why the changes are being made and ideally how it's useful to end users.
1 parent e1f5e3e commit 7cb76f5

4 files changed

Lines changed: 25 additions & 14 deletions

File tree

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# @TravisEz13 @PaulHigin
1414

1515
# Area: Documentation
16-
# @joeyaiello @TravisEz13
16+
.github/ @joeyaiello @TravisEz13
1717

1818
# Area: Test
1919
# @JamesWTruher @TravisEz13 @adityapatwardhan

.github/CONTRIBUTING.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -129,19 +129,20 @@ Additional references:
129129
If the changes are related to an existing GitHub issue,
130130
please reference the issue in PR description (e.g. ```Fix #11```).
131131
See [this][closing-via-message] for more details.
132-
* If the change warrants a note in the [changelog](../CHANGELOG.MD)
133-
either update the changelog in your pull request or
134-
add a comment in the PR description saying that the change may warrant a note in the changelog.
135-
New changes always go into the **Unreleased** section.
132+
133+
#### Pull request - Change log
134+
135+
* All PRs must update the [changelog](../CHANGELOG.MD) in your pull request.
136+
New changes always go into the **Unreleased** section at the top of the changelog.
136137
Keeping the changelog up-to-date simplifies the release process for Maintainers.
137138
An example (with an associated PR #):
138139

139140
```markdown
140-
Unreleased
141-
----------
141+
## Unreleased
142142

143-
* `Update-Item` now supports `-FriendlyName` (#1234).
143+
* `Update-Item` now supports `-FriendlyName` (#1234, @ExampleUser).
144144
```
145+
Note: Please add `**Breaking Change**` to the front of the entry in the changelog if the change is [breaking.](#making-breaking-changes)
145146

146147
* Please use the present tense and imperative mood when describing your changes:
147148
* Instead of "Adding support for Windows Server 2012 R2", write "Add support for Windows Server 2012 R2".

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
<!--
1+
## PR Checklist
22

3-
If you are a PowerShell Team member, please make sure you choose the Reviewer(s) and Assignee for your PR.
4-
If you are not from the PowerShell Team, you can leave the fields blank and the Maintainers will choose them for you. If you are familiar with the team, feel free to mention some Reviewers yourself.
3+
Note: Please mark anything not applicable to this PR `NA`.
4+
- [ ] [PR has a meaningful title](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
5+
- [ ] Use the present tense and imperative mood when describing your changes
6+
- [ ] [Summarized changes](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
7+
- [ ] [Update the changelog](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---changelog)
8+
- [ ] User facing [Documentation needed](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#pull-request---submission)
9+
- [ ] Issue filed - Issue link:
10+
- [ ] [Change is not breaking](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md#making-breaking-changes)
11+
- [ ] [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)
12+
- [ ] [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)
513

6-
For more information about the roles of Reviewer and Assignee, refer to [CONTRIBUTING.md](https://github.com/PowerShell/PowerShell/blob/master/.github/CONTRIBUTING.md).
7-
8-
-->
14+
## PR Summary

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## Unreleased
4+
5+
- Update the contribution guideline to note that updating the changelog is required. (#5586)
6+
37
## v6.0.0-rc - 2017-11-16
48

59
### Breaking changes

0 commit comments

Comments
 (0)