Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WTH Core] Contribution guide spell check updates #902

Open
wants to merge 30 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
e65df45
Added OpenAI Fundamentals to WTH home page AND linked to it from the …
jrzyshr Nov 7, 2023
b83d74b
added whitelist file for 002
jrzyshr Nov 7, 2023
3f6f298
Merge branch 'microsoft:master' into master
jrzyshr Nov 7, 2023
3973afb
Merge branch 'microsoft:master' into master
jrzyshr Dec 5, 2023
1b92a0a
Merge branch 'microsoft:master' into master
jrzyshr Dec 12, 2023
18e8550
Merge branch 'microsoft:master' into master
jrzyshr Jan 17, 2024
67c9f97
Merge branch 'microsoft:master' into master
jrzyshr Jan 23, 2024
b8115a8
Merge branch 'microsoft:master' into master
jrzyshr Feb 9, 2024
d69563f
Merge branch 'microsoft:master' into master
jrzyshr Feb 23, 2024
22142d3
Merge branch 'microsoft:master' into master
jrzyshr Feb 23, 2024
7bd80d5
Merge branch 'microsoft:master' into master
jrzyshr Mar 14, 2024
a8e4ac0
Merge branch 'microsoft:master' into master
jrzyshr Mar 15, 2024
d584855
Merge branch 'microsoft:master' into master
jrzyshr Mar 15, 2024
497b2d1
Merge branch 'microsoft:master' into master
jrzyshr Mar 27, 2024
d54c667
Merge branch 'microsoft:master' into master
jrzyshr Apr 11, 2024
67fd4b0
Update README.md
jrzyshr Apr 11, 2024
e372835
Merge pull request #68 from jrzyshr/jrzyshr-patch-1
jrzyshr Apr 11, 2024
be9dfdb
Merge branch 'microsoft:master' into master
jrzyshr Apr 11, 2024
c601045
Merge branch 'microsoft:master' into master
jrzyshr Apr 25, 2024
533cc5f
Merge branch 'microsoft:master' into master
jrzyshr Apr 25, 2024
2f96c05
Merge branch 'microsoft:master' into master
jrzyshr May 1, 2024
e7c48cf
Merge branch 'microsoft:master' into master
jrzyshr May 1, 2024
dc8e471
Merge branch 'microsoft:master' into master
jrzyshr May 8, 2024
c66b443
Update spellcheck.yml
jrzyshr May 13, 2024
9911956
Merge branch 'microsoft:master' into master
jrzyshr May 13, 2024
fea0bd2
Merge branch 'microsoft:master' into master
jrzyshr Oct 16, 2024
f232b13
Update CONTRIBUTING.md
jrzyshr Oct 18, 2024
328defb
Update CONTRIBUTING.md
jrzyshr Oct 18, 2024
1137544
Update CONTRIBUTING.md
jrzyshr Oct 18, 2024
fbd6fbd
Update CONTRIBUTING.md
jrzyshr Oct 18, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -184,15 +184,29 @@ When you feel your hack is finished and ready for release, this is the process w

### Spell Check

A spell checker will run on each new pull request submitted and again each time additional commits are made against that pull request. It will use common English words as well as technical terms from the `.github/workflows/spell-check/.wordlist.txt` file.
A spell checker will run on each new pull request submitted and again each time additional commits are made against that pull request. It will use common English words as well as technical terms from the `.github/workflows/spell-check/.wordlist.txt` file. The spell checker ignores content within code blocks.

This will run on each pull request that is submitted to the `master` branch.

If the spell check fails, click the `Details` link as highlighted in the image below, to reveal the spelling errors that were detected.

![Spell Check Fail](000-HowToHack/images/spell-check-fail.png?raw=true "Spell Check Fail")

The spelling errors will be listed along side of each page that they occurred on as in the image below:

![Spell Check Misspelled Words](000-HowToHack/images/spell-check-misspelled-words.png?raw=true "Spell Check Misspelled Words")

If you have unique or technical words that are not already in the global `.wordlist` file, you can add your own list. Add a file called `.wordlist.txt` to your new WTH sub-directory and include all the words you want the spell checker to ignore. There should be 1 word on each line (similar to how the `.github/workflows/spell-check/.wordlist.txt` file is formatted).
If the spell checker detects spelling errors, you have 3 options for resolving them:

- Fix the misspelled word!
- 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.
- There should be 1 word on each line (similar to how the `.github/workflows/spell-check/.wordlist.txt` file is formatted).

### Use Draft Pull Requests for Early Feedback

Expand Down