Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jrzyshr authored Oct 18, 2024
1 parent 1137544 commit fbd6fbd
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit fbd6fbd

Please sign in to comment.