From c1b1af0b0e168710471c8fe716047a2cd6642f68 Mon Sep 17 00:00:00 2001 From: Egor Savkin Date: Thu, 16 May 2024 13:04:05 +0800 Subject: [PATCH] Add inclusivity/accessibility/user-friendliness tip into `Contributing` Signed-off-by: Egor Savkin --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 84daadc..b5dbdde 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,9 @@ Tips for adding hardware instructions: for images with transparent background) 3. Add link to the new chapter to the `src/SUMMARY.md` 4. Do not forget to tell about all hidden/non-obvious obstacles and pitfalls -5. Add testing steps, even the "obvious" ones -6. Add JSON sample if needed -7. Add hardware setup (e.g. pins, switches) steps if needed -8. View changed and added pages with `mdbook build` (see building instructions above) +5. Avoid using uncommon, complex, or hard-to-understand words, phrases, or grammar (e.g., ❌constituent -> ✔️component). + Keep in mind that these guides may be used by people with different backgrounds and levels of English proficiency. +6. Add testing steps, even the "obvious" ones +7. Add JSON sample if needed +8. Add hardware setup (e.g. pins, switches) steps if needed +9. View changed and added pages with `mdbook build` (see building instructions above)