Skip to content

Commit 133ee6b

Browse files
authored
Merge pull request #9812 from cormacpayne/doc-updates
Minor fixes to PR template and CONTRIBUTING.md
2 parents 374f33e + fa8e7aa commit 133ee6b

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,13 @@
66

77
## Checklist
88

9-
- [ ] I have read the [_Submitting Changes_](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md)
9+
- [ ] I have read the [_Submitting Changes_](../CONTRIBUTING.md#submitting-changes) section of [`CONTRIBUTING.md`](../CONTRIBUTING.md)
1010
- [ ] The title of the PR is clear and informative
11-
- [ ] The appropriate [change log has been updated](https://github.com/Azure/azure-powershell/blob/master/CONTRIBUTING.md#updating-the-change-log)
12-
- [ ] The PR does not introduce [breaking changes](https://github.com/Azure/azure-powershell/blob/master/documentation/breaking-changes/breaking-changes-definition.md)
11+
- [ ] The appropriate `ChangeLog.md` file(s) has been updated:
12+
- For any service, the `ChangeLog.md` file can be found at `src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md`
13+
- A snippet outlining the change(s) made in the PR should be written under the `## Upcoming Release` header -- no new version header should be added
14+
- [ ] The PR does not introduce [breaking changes](../documentation/breaking-changes/breaking-changes-definition.md)
1315
- [ ] If applicable, the changes made in the PR have proper test coverage
1416
- [ ] For public API changes to cmdlets:
15-
- [ ] the changes have gone through a [cmdlet design review](https://github.com/Azure/azure-powershell-cmdlet-review-pr) (Microsoft internal partners only)
16-
- [ ] the cmdlet markdown files were [generated using the `platyPS` module](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md)
17+
- [ ] a cmdlet design review was approved for the changes in [this repository](https://github.com/Azure/azure-powershell-cmdlet-review-pr)
18+
- [ ] the markdown help files have been regenerated using the commands listed [here](../documentation/development-docs/help-generation.md#updating-all-markdown-files-in-a-module)

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,14 @@ The following is a list of guidelines that pull requests opened in the Azure Pow
6565
The following guidelines must be followed in **EVERY** pull request that is opened.
6666

6767
- Title of the pull request is clear and informative
68-
- The appropriate `ChangeLog.md` file has been updated with a snippet describing the changes being made
68+
- The appropriate `ChangeLog.md` file(s) has been updated:
69+
- For any service, the `ChangeLog.md` file can be found at `src/{{SERVICE}}/{{SERVICE}}/ChangeLog.md`
70+
- A snippet outlining the change(s) made in the PR should be written under the `## Upcoming Release` header -- no new version header should be added
6971
- There are a [small number of commits](documentation/development-docs/cleaning-up-commits.md) that each have an informative message
7072
- All files shipped with a module should contain a proper Microsoft license header
7173
- For public API changes to cmdlets:
7274
- a cmdlet design review was approved for the changes in [this repository](https://github.com/Azure/azure-powershell-cmdlet-review-pr)
73-
- the markdown help files have been regenerated using the commands listed [here](https://github.com/Azure/azure-powershell/blob/master/documentation/development-docs/help-generation.md#updating-all-markdown-files-in-a-module)
75+
- the markdown help files have been regenerated using the commands listed [here](documentation/development-docs/help-generation.md#updating-all-markdown-files-in-a-module)
7476

7577
#### Testing guidelines
7678

0 commit comments

Comments
 (0)