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/pr-template-with-comments-to-guidance.jpg b/rules/use-pull-request-templates-to-communicate-expectations/pr-template-with-comments-to-guidance.jpg index 95d965d1130..0f039595d45 100644 Binary files a/rules/use-pull-request-templates-to-communicate-expectations/pr-template-with-comments-to-guidance.jpg and b/rules/use-pull-request-templates-to-communicate-expectations/pr-template-with-comments-to-guidance.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 4ff6d8b2729..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,8 +26,12 @@ 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 - This PR template contains guidance for the context needed to review, along with 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.