Adding an ok example for the comments only approach to PR templates

SSWConsulting · Nov 7, 2023 · 40b15e6 · 40b15e6
1 parent 661a699
commit 40b15e6
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/...equest-templates-to-communicate-expectations/pr-template-asking-for-context.jpg b/...equest-templates-to-communicate-expectations/pr-template-asking-for-context.jpg
diff --git a/...templates-to-communicate-expectations/pr-template-with-comments-to-guidance.jpg b/...templates-to-communicate-expectations/pr-template-with-comments-to-guidance.jpg
diff --git 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.