Skip to content

Commit

Permalink
docs(readme): add CSpell section and how to configure auto spell checker
Browse files Browse the repository at this point in the history
  • Loading branch information
mohammadGh committed Apr 21, 2024
1 parent 55dc2ea commit 3b06b05
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,16 @@ We use `release-it` for version management and publish to anywhere (npm or githu
## Auto Changelog based on Conventional Commits
We use `changelogen` to generate beautiful changelogs using Conventional Commits.

## CSpell
`CSpell` used to automatically check for spelling errors when committing files and writing commit messages.

If there are spelling errors in the staged files for commit, `husky` will prevent you from committing.
Also, if the commit message text has spelling errors, `husky` will still prevent the commit.

Additional Notes:

- You can configure CSpell in `cspell.json` file in your project directory.
- You can list words that you want `CSpell` to ignore in `/project-words.txt` file.

## License
[MIT](./LICENSE) License

0 comments on commit 3b06b05

Please sign in to comment.