Skip to content

Commit 2929eec

Browse files
authored
Add doc requirements to PR template (magento#739)
1 parent da8f63d commit 2929eec

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
<!---
1313
Please provide a description of the changes proposed in the pull request.
1414
Letting us know what has changed and why it needed changing will help us validate this pull request.
15+
16+
If this PR was initiated by an internal JIRA ticket, copy the description from the ticket here so that the information is visible to contributors from the Magento Cloud Community.
1517
-->
1618

1719
### Fixed Issues (if relevant)
@@ -30,8 +32,19 @@
3032
1. ...
3133
2. ...
3234

35+
### Release notes
36+
37+
For user-facing changes, add a meaningful release note. For examples, see [Magento Cloud ECE-tools release notes](https://devdocs.magento.com/cloud/release-notes/ece-release-notes.html).
38+
39+
### Associated documentation updates
40+
<!--
41+
If your proposed update requires user documentation, submit a PR to the Magento DevDocs repository. For extensive updates requiring assistance, submit an issue to DevDocs. See https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md.
42+
-->
43+
Add link to Magento DevDocs PR or Issue, if needed.
44+
3345
### Contribution checklist
3446
- [ ] Pull request has a meaningful description of its purpose
47+
- [ ] Pull request introduces user-facing changes and includes meaningful updates for any required release notes and documentation changes
3548
- [ ] All commits are accompanied by meaningful commit messages
3649
- [ ] All new or changed code is covered with unit/integration tests (if applicable)
3750
- [ ] All automated tests passed successfully (all builds on Travis CI are green)

0 commit comments

Comments
 (0)