Skip to content

Commit 2bd84b0

Browse files
committed
Update the contributing guide
Add sub-section about spell checker. Signed-off-by: Martin Hickey <[email protected]>
1 parent 81ff41f commit 2bd84b0

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

.spellcheck-en-custom.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ pyenv
7474
pylint
7575
pygraphviz
7676
pyproject
77+
pyspelling
7778
pytest
7879
QAT
7980
QAT'ed

CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ pip install tox
8888

8989
If you want to manage your own virtual environment instead of using `tox`, you can install the model optimizer and all dependencies. Check out [installation](./README.md#installation) for more details.
9090

91-
Before pushing changes to GitHub, you need to run the tests and coding style as shown below. They can be run individually as shown in each sub-section or can be run with the one command:
91+
Before pushing changes to GitHub, you need to run the tests, coding style and spelling check as shown below. They can be run individually as shown in each sub-section or can be run with the one command:
9292

9393
```shell
9494
tox
@@ -137,6 +137,16 @@ You can invoke the linting with the following command
137137
tox -e lint
138138
```
139139

140+
### Spelling check
141+
142+
Spelling check is enforced by the CI system. Run the checker before pushing the changes to avoid CI issues. We use [pyspelling](https://github.com/facelessuser/pyspelling) spell check automation tool. It is a wrapper around CLI of [Aspell](http://aspell.net/) and [Hunspell](https://hunspell.github.io) which are spell checker tools. We configure `pyspelling` to use `Aspell` as the spell checker tool of choice.
143+
144+
Running the spelling check is as simple as:
145+
146+
```sh
147+
tox -e spellcheck
148+
```
149+
140150
## Your First Code Contribution
141151

142152
Unsure where to begin contributing? You can start by looking through these issues:

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[tox]
2-
envlist = ruff, lint, unit
2+
envlist = ruff, lint, spellcheck, unit
33
minversion = 4.4
44

55
[testenv]

0 commit comments

Comments
 (0)