Update Rule “update-a-github-issue/rule”

SSWConsulting · Oct 3, 2023 · 2083f54 · 2083f54
1 parent 96a7184
commit 2083f54
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/rules/update-a-github-issue/bad-example-lots-of-non-descriptive-comments.png b/rules/update-a-github-issue/bad-example-lots-of-non-descriptive-comments.png
diff --git a/rules/update-a-github-issue/rule.md b/rules/update-a-github-issue/rule.md
@@ -1,7 +1,7 @@
 ---
 type: rule
-title: Do you know how to update a GitHub issue?
-uri: update-a-github-issue
+title: Do you to keep a PBI's current status visible?
+uri: keeping-pbis-status-visible
 authors:
   - title: Brook Jeynes
     url: https://www.ssw.com.au/people/brook-jeynes/
@@ -17,6 +17,12 @@ As issues evolve, it's common for their initial descriptions to become outdated
 
 Whenever an issue necessitates an update, the team should add a comment to the issue, detailing the change or event. 
 
+::: bad
+
+![Figure: Lots of non-descriptive comments cluttering the issue.](bad-example-lots-of-non-descriptive-comments.png)
+
+:::
+
 ::: good
 
 ![Figure: Extra context added via comment.](good-example-adding-context-via-comment.png)