about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorMichael Vetter <jubalh@iodoru.org>2021-10-05 09:49:50 +0200
committerMichael Vetter <jubalh@iodoru.org>2021-10-05 09:49:50 +0200
commitce5bf721cad03ce660b1c365e0d96d58c90dcf51 (patch)
tree80af9c050dd1df80e3a0dc3a14846306903aa089
parent16df5d825537c0f624f2b8528b5f72179d3feb55 (diff)
downloadprofani-tty-ce5bf721cad03ce660b1c365e0d96d58c90dcf51.tar.gz
Mention make spell and doublecheck in contributing.md
-rw-r--r--CONTRIBUTING.md4
1 files changed, 4 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.