Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

XS✔ ◾ CodeAuditor - Fix broken link #8368

Merged
merged 2 commits into from
Apr 15, 2024
Merged

XS✔ ◾ CodeAuditor - Fix broken link #8368

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7aaa84
CodeAuditor - Fix broken link
tombui99 Apr 15, 2024
88707f4
Update rule.md
tiagov8 Apr 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions rules/dones-do-your-dones-include-a-url/rule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
Loading