File tree Expand file tree Collapse file tree 1 file changed +2
-2
lines changed
Expand file tree Collapse file tree 1 file changed +2
-2
lines changed Original file line number Diff line number Diff line change @@ -53,7 +53,7 @@ This list is non-exhaustive. If there is something you would like to see on the
5353- Use clear headers (` ## ` , ` ### ` ) to organize sections.
5454- Limit paragraphs to 3–5 sentences.
5555- Use bullet points or numbered lists for step-by-step content.
56- - Include ** code samples** where relevant (see Code Style below) .
56+ - Include ** code samples** where relevant.
5757- Use callouts for ** tips** , ** warnings** , or ** best practices** .
5858
5959### Conclusion
@@ -73,7 +73,7 @@ This list is non-exhaustive. If there is something you would like to see on the
7373## ❌ Don't
7474
7575- Don’t assume the reader knows your stack.
76- - Don't overuse of metaphors. Use them sparingly to aid understanding.
76+ - Don't overuse metaphors; use them sparingly to aid understanding.
7777- Don't overuse passive voice. Active voice often brings more clarity.
7878- Don't overuse future tense. The present tense often brings more clarity.
7979
You can’t perform that action at this time.
0 commit comments