From 3b06b051ba7346ecc6a7eae38d2ecaa26efba8f2 Mon Sep 17 00:00:00 2001 From: mgh Date: Sun, 21 Apr 2024 17:40:25 +0330 Subject: [PATCH] docs(readme): add CSpell section and how to configure auto spell checker --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index f64f7bf..2bbb717 100644 --- a/README.md +++ b/README.md @@ -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