Skip to content

Commit

Permalink
chore: Update README file on how to ignore Unkown Words
Browse files Browse the repository at this point in the history
  • Loading branch information
sowmya-kota07 committed Dec 4, 2023
1 parent 3fbca04 commit 2c44a44
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit 2c44a44

Please sign in to comment.