docs: contributing instructions (#74)

Co-authored-by: Mitchell Hanberg <[email protected]>
elixir-tools · Jun 27, 2023 · 716f271 · 716f271
1 parent 820e655
commit 716f271
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -134,6 +134,18 @@ Check: `Credo.Check.Readability.ModuleDoc`
 
 Inject a `@moduledoc false` snippet into the module.
 
+## Contributing
+
+### Running tests
+
+```sh
+# setup the test project
+$ (cd test/support/project && mix deps.get)
+
+# run the tests
+$ mix test
+```
+
 ---
 
 Built with [gen_lsp](https://github.com/mhanberg/gen_lsp)