From fbd6fbd53dd264d4c0b12610dc851136e8c94e9e Mon Sep 17 00:00:00 2001 From: "Peter C. Laudati" Date: Thu, 17 Oct 2024 22:59:36 -0400 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2d38099e8e..24ca7a340a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -199,9 +199,10 @@ The spelling errors will be listed along side of each page that they occurred on If the spell checker detects spelling errors, you have 3 options for resolving them: - Fix the misspelled word! -- Wrap it in a code block with backticks (\`\`). +- Wrap the word in a code block with backticks (\`\`). - If the word is a programatic term, object or variable name, form field, etc. (i.e. `databaseName` or `ColumnName`), you should wrap the word in backticks (\`\`) which will make it a code block. - This will make your content more readable by making these terms stand out on the page. + - The majority of words flagged by the spell checker usually fall into this category. - Add the word to the whitelist for your hack. - Adding words to the whitelist should be reserved for proper names like a product name (i.e. "Kubernetes"), or a term that is part of the vocabulary for a given technology (i.e. "kubectl") - Add a file called `.wordlist.txt` to your new WTH sub-directory and include all the words you want the spell checker to ignore.