From d2eadd08320ee612b4d082548a3af87395c05377 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tiago=20Ara=C3=BAjo=20=5BSSW=5D?= Date: Wed, 19 Feb 2025 11:31:23 -0300 Subject: [PATCH] =?UTF-8?q?XS=20=E2=97=BE=20Update=20and=20rename=20rule.m?= =?UTF-8?q?d=20to=20rule.md=20(#9918)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../communication/rules-to-better-email.md | 2 +- .../rules-to-better-github.md | 2 +- rules/change-from-x-to-y/rule.md | 1 + .../rule.md | 35 ++++++++++--------- 4 files changed, 22 insertions(+), 18 deletions(-) rename rules/{do-you-use-indentation-for-readability => indent}/rule.md (84%) diff --git a/categories/communication/rules-to-better-email.md b/categories/communication/rules-to-better-email.md index c6c0a4751c8..87aa9e8d002 100644 --- a/categories/communication/rules-to-better-email.md +++ b/categories/communication/rules-to-better-email.md @@ -54,7 +54,7 @@ index: - do-you-know-when-and-when-not-to-use-email - do-you-prepare-then-confirm-conversations-decisions - do-you-respond-to-each-email-individually -- do-you-use-indentation-for-readability +- indent - enforce-the-text-meaning-with-icons-and-emojis - email-avoid-inline - are-you-careful-with-your-spelling-grammar-and-punctuation diff --git a/categories/software-engineering/rules-to-better-github.md b/categories/software-engineering/rules-to-better-github.md index e3ba72a79cf..ea063817798 100644 --- a/categories/software-engineering/rules-to-better-github.md +++ b/categories/software-engineering/rules-to-better-github.md @@ -18,7 +18,7 @@ index: - useful-information-on-changes - rubber-stamp-prs - adding-changes-to-pull-requests - - do-you-use-indentation-for-readability + - indent - do-you-know-to-the-requirements-to-create-a-new-repository - use-emojis-in-your-commits - turn-emails-into-a-github-issue diff --git a/rules/change-from-x-to-y/rule.md b/rules/change-from-x-to-y/rule.md index 3e6bb47ea5d..1f29a086a8e 100644 --- a/rules/change-from-x-to-y/rule.md +++ b/rules/change-from-x-to-y/rule.md @@ -16,6 +16,7 @@ authors: url: https://ssw.com.au/people/ulysses-maclaren related: - github-content-changes + - indent redirects: - do-you-ask-for-content-changes-using-from-x-to-y created: 2009-03-25T04:50:21.000Z diff --git a/rules/do-you-use-indentation-for-readability/rule.md b/rules/indent/rule.md similarity index 84% rename from rules/do-you-use-indentation-for-readability/rule.md rename to rules/indent/rule.md index 3690c53c9a4..92a26fb366a 100644 --- a/rules/do-you-use-indentation-for-readability/rule.md +++ b/rules/indent/rule.md @@ -1,10 +1,8 @@ --- type: rule title: Do you use indentation for readability? -seoDescription: Learn how to enhance your email communication by using - indentation for readability. Discover tips and tricks to effectively reply to - emails and improve understanding. -uri: do-you-use-indentation-for-readability +seoDescription: Learn how to enhance your email communication by using indentation for readability. Discover tips and tricks to effectively reply to emails and improve understanding. +uri: indent authors: - title: Adam Cogan url: https://ssw.com.au/people/adam-cogan @@ -16,16 +14,20 @@ authors: url: https://ssw.com.au/people/tiago-araujo related: - when-you-reply-inline-do-you-use-a-different-color -redirects: [] + - change-from-x-to-y +redirects: + - do-you-use-indentation-for-readability created: 2010-09-01T02:53:29.000Z archivedreason: null guid: 1899c3db-ac1b-468e-a8e7-f2cdc5e0748a --- Written communication can easily cause misunderstandings. Help the reader understand your message better by: -* Using “>” and indentation when quoting the text from others, like the original email you are replying to, or a web page, etc. -* Your new text should be kept to the left -* Add numbers if the sender didn't and it is appropriate +* Using “>” and indentation when quoting the text from others, like the original email you are replying to + **Note:** “>” is not needed when quoting from a web page +* Your text should be kept to the left +* [Add numbers to tasks](/number-tasks-questions) if the sender forgot + Mention you changed the history. E.g. “(added numbers to tasks in the history, so I can refer to ones)” @@ -34,13 +36,14 @@ This way you won't forget any questions in the original email. **Note:** You do not need to use ">" and indentation, when you are replying to the task that is very clear, because in this case extra text reduces clarity. ::: email-template + | | | | -------- | --- | | To: | Adam | | Subject: | RE: Change on Northwind app | ::: email-content -### Hi Adam, +### Hi Adam Please change from X to Y\ The program flow logic worries me a bit\ @@ -53,39 +56,39 @@ Figure: Bad example - There's too much information with no reasonable order ::: ::: email-template + | | | | -------- | --- | | To: | Adam | | Subject: | RE: Change on Northwind app | ::: email-content -### Hi Adam, +### Hi Adam     > 1. Please change from X to Y\ -Done - {{ LINK }}\ +Done - northwind365.com\     > 2. The program flow logic worries me a bit\ Sorry, this wasn't a final decision - I just put it there for testing purposes ::: ::: ::: bad -Figure: Bad example - Even with order, without spacing the text becomes cramped and hard to read. +Figure: Bad example - Even with order, without spacing the text becomes cramped and hard to read ::: ::: email-template + | | | | -------- | --- | | To: | Adam | | Subject: | RE: Change on Northwind app | ::: email-content -### Hi Adam, +### Hi Adam     > 1. Please change from X to Y -Done - {{ LINK }} - -  +Done - northwind365.com     > 2. The program flow logic worries me a bit