Skip to content

Commit 379344d

Browse files
Copilotsofthack007
andauthored
Add readability, grammar, and style checklist items to AGENTS.md
Agent-Logs-Url: https://github.com/wled/WLED-Docs/sessions/2ca91630-7538-47c6-826d-5489f3d477a5 Co-authored-by: softhack007 <91616163+softhack007@users.noreply.github.com>
1 parent 9b25e0f commit 379344d

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,14 @@ When reviewing a pull request, verify the following:
105105
- [ ] Code blocks use language identifiers.
106106
- [ ] No unintentional trailing whitespace (two trailing spaces are allowed for forced line breaks).
107107

108+
### Writing Style & Readability
109+
110+
- [ ] Tone is **informal, friendly, and inviting** — avoid overly formal or academic language.
111+
- [ ] Language is **simple and clear** — short sentences, common words, no unexplained jargon — so non-native English speakers can easily follow.
112+
- [ ] No grammar or spelling mistakes.
113+
- [ ] Wording is **concise** — remove filler phrases (e.g. "it is worth noting that", "basically", "simply") and redundant sentences.
114+
- [ ] Contractions (e.g. "you'll", "don't", "it's") are welcome — they help keep the tone approachable.
115+
108116
### Navigation
109117

110118
- [ ] If a new page is added, it is registered in the `nav:` section of `mkdocs.yml` at the correct location and indentation level.

0 commit comments

Comments
 (0)