diff options
| -rw-r--r-- | CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | Makefile.am | 5 |
2 files changed, 9 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c807c30..7eb92846 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,7 @@ # Contributing to Profanity +`make doublecheck` will run the code formatter, spell checker and unit tests. + ## Coding style Follow the style already present ;-) @@ -59,3 +61,5 @@ scan-view ... We include a `.codespellrc` configuration file for `codespell` in the root directory. Before comitting it might make sense to run `codespell` to see if you made any typos. + +You can run the `make spell` command for this. diff --git a/Makefile.am b/Makefile.am index d40494d1..d537135e 100644 --- a/Makefile.am +++ b/Makefile.am @@ -339,3 +339,8 @@ check-unit: tests/unittests/unittests format: $(all_c_sources) clang-format -i $(all_c_sources) + +spell: + codespell + +doublecheck: format check spell |