devs/cproof
1
2
Fork 1
Code Issues 43 Pull Requests 10 Actions Packages Projects 1 Releases Wiki Activity

Mention make spell and doublecheck in contributing.md

Browse Source
This commit is contained in:
Michael Vetter
2021-10-05 09:49:50 +02:00
parent 16df5d8255
commit ce5bf721ca
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@@ -1,5 +1,7 @@
# Contributing to Profanity # Contributing to Profanity
`make doublecheck` will run the code formatter, spell checker and unit tests.
## Coding style ## Coding style
Follow the style already present ;-) Follow the style already present ;-)
@@ -59,3 +61,5 @@ scan-view ...
We include a `.codespellrc` configuration file for `codespell` in the root directory. 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. 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.