From a57f354e370496c0e782a8ff8095251f9d6a9321 Mon Sep 17 00:00:00 2001 From: Valentin Gagarin Date: Fri, 29 Jul 2022 01:21:59 +0200 Subject: [PATCH] style guide: use culturally neutral language --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39fde47..022ca68 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,3 +14,19 @@ Address the reader with "you" when necessary. Clarify identity if you use "we". Generally, "we" are the Nix community and, more specifically, nix.dev authors. +Use culturally neutral language: + +- Avoid idioms. + + Idioms can be hard to understand for non-native English speakers. + +- Do not try to be funny. + + Humor is highly culturally sensitive. + At best, jokes may obfuscate the relevant instructions. + At worst, jokes may offend readers and invalidate our effort to help them learn. + +- Do not use references to popular culture. + + What you may consider well-known may be entirely obscure and distracting to people from different backgrounds. +