From 2c44a446ee6c4999caf6b6c71f14ab59c1761d8f Mon Sep 17 00:00:00 2001 From: Sowmya Kota Date: Mon, 4 Dec 2023 11:49:19 -0800 Subject: [PATCH] chore: Update README file on how to ignore Unkown Words --- Readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/Readme.md b/Readme.md index c6b00962298..220c744c68b 100644 --- a/Readme.md +++ b/Readme.md @@ -27,6 +27,7 @@ We welcome contributions to the documentation site! Here's how to do it: 2. If any files have been deleted with your PR, please add the redirects required to [`redirects.json`](https://github.com/aws-amplify/docs/blob/main/redirects.json) and ensure that the `redirects-needed` label has been added. - Please see the [Amplify Hosting user guide](https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html) for guidance on values and ordering. - Please note that there is a manual step for the Docs Engineering team to complete before the redirects are live. +4. If the spell-check flags any 'Unknown words' while you're making a pull request, please add these words to the `"words"` list in [cspell.json](https://github.com/aws-amplify/docs/blob/main/cspell.json#L4) to ignore them. **What's next?** After your PR is reviewed and all tests pass, it will be merged and the branch will be deleted.