diff --git a/rules/use-pull-request-templates-to-communicate-expectations/pr-template-asking-for-context.jpg b/rules/use-pull-request-templates-to-communicate-expectations/pr-template-asking-for-context.jpg new file mode 100644 index 00000000000..95d965d1130 Binary files /dev/null and b/rules/use-pull-request-templates-to-communicate-expectations/pr-template-asking-for-context.jpg differ diff --git a/rules/use-pull-request-templates-to-communicate-expectations/rule.md b/rules/use-pull-request-templates-to-communicate-expectations/rule.md index 1fdece9bd6b..ef0cea063f4 100644 --- a/rules/use-pull-request-templates-to-communicate-expectations/rule.md +++ b/rules/use-pull-request-templates-to-communicate-expectations/rule.md @@ -26,9 +26,14 @@ When creating a PR template, think of how you can help developers create great P ![Figure: Bad example - There is no information to guide developers](no-pr-template.jpg) ::: +::: ok +![Figure: OK example - The PR template contains handy links to guidance for creating great PRs ⭐](pr-template-with-comments-to-guidance.jpg) +::: + ::: good -![Figure: Good example - The PR template contains handy links to guidance for creating great PRs ⭐](pr-template-with-comments-to-guidance.jpg) +![Figure: Good example - This PR template asks for **context needed to review**, along with links to guidance for creating great PRs ⭐](pr-template-asking-for-context.jpg) ::: **Tip:** You can use comments in the markdown as above. These comments will not show when the PR is created, and is only visible when editing the description. - \ No newline at end of file + +For a great Pull Request template, take a look at [@SSWConsulting/SSW.GitHub.Template](https://github.com/SSWConsulting/SSW.GitHub.Template/blob/main/.github/pull_request_template.md) diff --git a/rules/write-a-good-pull-request/rule.md b/rules/write-a-good-pull-request/rule.md index 4e147eb398d..ffac25c373b 100644 --- a/rules/write-a-good-pull-request/rule.md +++ b/rules/write-a-good-pull-request/rule.md @@ -21,6 +21,7 @@ related: - use-emojis-in-your-commits - which-emojis-to-use-in-scrum - use-emojis + - use-pull-request-templates-to-communicate-expectations redirects: - do-you-know-how-to-write-a-good-pull-request created: 2020-07-17T01:21:08.000Z @@ -176,7 +177,6 @@ A: If you're using a GUI editor for your PRs, you may need to go to the PR after ![Figure: Good example - Updating the PR description to follow the repository standard helps you provide context to reviewers](cms-good-example.png) ::: - ### 3. Link the Pull Request to the associated issues / PBIs ::: info