diff options
| author | Jos Verlinde <jos_verlinde@hotmail.com> | 2023-08-03 22:22:02 +0200 |
|---|---|---|
| committer | Damien George <damien@micropython.org> | 2024-01-25 11:50:07 +1100 |
| commit | c8772b7baa972f17c08f82af584ac2b13f4c1737 (patch) | |
| tree | a2b2d0a8cc415af984dadfca6e9a579ea41a7d6c | |
| parent | a166d805f437e9f4bb81be1dd9d880bd8fb4b0ed (diff) | |
CODECONVENTIONS: Update docs for codespell and pre-commit hook.
Signed-off-by: Jos Verlinde <jos_verlinde@hotmail.com>
| -rw-r--r-- | CODECONVENTIONS.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/CODECONVENTIONS.md b/CODECONVENTIONS.md index d6b0a5926..d6af0418e 100644 --- a/CODECONVENTIONS.md +++ b/CODECONVENTIONS.md @@ -104,6 +104,22 @@ This command may work, please raise a new Issue if it doesn't: curl -L https://github.com/Homebrew/homebrew-core/raw/2b07d8192623365078a8b855a164ebcdf81494a6/Formula/uncrustify.rb > uncrustify.rb && brew install uncrustify.rb && rm uncrustify.rb ``` +Code spell checking +=================== + +Code spell checking is done using [codespell](https://github.com/codespell-project/codespell#codespell) +and runs in a GitHub action in CI. Codespell is configured via `pyproject.toml` +to avoid false positives. It is recommended run codespell before submitting a +PR. To simplify this, codespell is configured as a pre-commit hook and will be +installed if you run `pre-commit install` (see below). + +If you want to install and run codespell manually, you can do so by running: + +``` +$ pip install codespell tomli +$ codespell +``` + Automatic Pre-Commit Hooks ========================== |