From a7aaa84b903abbf9fc2ee0bcd70e70650c2eebf5 Mon Sep 17 00:00:00 2001 From: "Tom Bui [SSW]" <67776356+tombui99@users.noreply.github.com> Date: Mon, 15 Apr 2024 14:12:25 +1000 Subject: [PATCH 1/2] CodeAuditor - Fix broken link --- rules/dones-do-your-dones-include-a-url/rule.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rules/dones-do-your-dones-include-a-url/rule.md b/rules/dones-do-your-dones-include-a-url/rule.md index 13c0fd74e19..482b49a24ef 100644 --- a/rules/dones-do-your-dones-include-a-url/rule.md +++ b/rules/dones-do-your-dones-include-a-url/rule.md @@ -21,7 +21,7 @@ guid: ed0fa76a-418b-4b59-9e3b-2544c08b910e --- -Always include the relevant URL to your emails, like when you want to request or just made a change to a webpage or document. This way people can easily check the details of the tasks. This is especially important for ["Done" emails](reply-done-and-delete-the-email). +Always include the relevant URL to your emails, like when you want to request or just made a change to a webpage or document. This way people can easily check the details of the tasks. This is especially important for ["Done" emails](/reply-done-and-delete-the-email). If you are using a task tracking system like **Azure DevOps**, **GitHub**, or Jira, also include the link to the PBI/Issue/task. From 88707f457aa629f1cf50ba850897b863ba5012c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tiago=20Ara=C3=BAjo=20=5BSSW=5D?= Date: Mon, 15 Apr 2024 10:07:20 -0700 Subject: [PATCH 2/2] Update rule.md --- rules/dones-do-your-dones-include-a-url/rule.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/rules/dones-do-your-dones-include-a-url/rule.md b/rules/dones-do-your-dones-include-a-url/rule.md index 482b49a24ef..0a997f2a78e 100644 --- a/rules/dones-do-your-dones-include-a-url/rule.md +++ b/rules/dones-do-your-dones-include-a-url/rule.md @@ -57,7 +57,7 @@ Figure: Good example - Easy to check what was done + includes the context of the Before declaring a task 'done' with a link, ensure that your changes are live and accessible for verification. -##### ❌ **Scenario:** PR waiting for approval +#### Scenario: ❌ PR waiting for approval ::: greybox Done - ssw.com.au/rules/dones-is-your-inbox-a-task-list-only @@ -83,7 +83,7 @@ Done - ssw.com.au/rules/dones-is-your-inbox-a-task-list-only Figure: OK example - Links are included, changes are not live yet, but people are aware ::: -##### ✅ **Scenario:** PR approved and merged +#### Scenario: ✅ PR approved and merged ::: greybox Done - ssw.com.au/rules/dones-is-your-inbox-a-task-list-only @@ -96,7 +96,7 @@ Figure: Good example - Final link is included and changes are live to be checked It is a common problem where someone CC'd will not have permissions to see a file and the sender knows this. You should still add the link but inform the recipient. -**Scenario:** Recipient doesn't have permissions. +#### Scenario: ❌ Recipient doesn't have permissions ::: greybox Done - onedrive.live.com/file-name.xls