diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 922da23b7bc2f0717da22d37729df959ce5ddcb4..3f271a1bc9688d3c2b7faff7d9b0a9e035033f54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,7 +24,8 @@ setup and development tasks. **Install dependencies** You'll need to have a working Rust environment to build the code, and a -working Git installation to fetch the code. +working Git installation to fetch the code. Additionally, please install +the SQLite 3 development files and shellcheck to successfully run git hooks. - [Rust](https://www.rust-lang.org/tools/install) note, for Windows devices check the @@ -36,7 +37,8 @@ working Git installation to fetch the code. - SQLite 3 development files (e.g. available via `apt install libsqlite3-dev`) -- To successfully run git hooks: [shellcheck](https://github.com/koalaman/shellcheck#installing) (used in [`maint/shellcheck_all`](./maint/shellcheck_all)) +- For git hooks: [shellcheck](https://github.com/koalaman/shellcheck#installing) + (used in [`maint/shellcheck_all`](./maint/shellcheck_all)) **Clone the source code**