All contributions are welcome and appreciated!
Need to open an issue? Click here or use one of the below links:
All that is needed to work with this repo is Rust and your favorite editor or IDE, although we recommend VS Code. You can run the dev_setup script described below to set up Rust in your environment if you do not already have Rust.
To build and/or work on this project:
Clone the repo, change into the directory where you cloned the directory and then run the dev setup script for your platform
git clone https://github.com/swellaby/rusty-hook.git
cd rusty-hookFor Linux, Mac, and Windows WSL:
./scripts/dev_setup.sh
For Windows:
.\scripts\dev_setup.ps1
Swellaby members should create a branch within the repository, make changes there, and then submit a Pull Request.
Outside contributors should fork the repository, make changes in the fork, and then submit a Pull Request. Check out the GitHub Forking Projects Guide for more info.
When you create a Pull Request to merge changes, the PR Validation Build Jobs in Azure Pipelines will be triggered automatically to run test coverage, format, and lint checks.
There are suites of unit tests that validate individual functions. The unit tests are defined in separate files that reside within the src directory alongside the application code. The tests are placed in a separate file by leveraging the Rust module path attribute on the test module declaration in each source file. We know the Rust convention is to place unit tests in the same file, but we like this way better!
The tests can be executed via cargo
Run the unit tests:
cargo testYou must write corresponding unit tests for any code you add or modify, and all tests must pass before those changes can be merged back to the master branch.
We're currently using kcov for code coverage, more detailed documentation coming soon.
We've got 100% code coverage (which intentionally excludes main.rs) that must be maintained for all new and modified code.
Naturally, we use clippy for linting.
To run the linter, use cargo:
cargo clippyWe use rustfmt to ensure consistent formatting of the Rust code.
To run rustfmt, use cargo:
cargo fmtThis repo utilizes itself for client side git hooks.
The git pre-commit hook is configured to run the unit tests so when you run a git commit, the pre-commit hook will trigger those tests. If any of the tests fail then your commit will be rejected, and you will need to fix the issue(s) before attempting to commit again.
You can optionally skip this hook by including the -n switch (i.e. git commit -n -m "...") if you are only trying to commit non-code content, like a markdown or TOML file.
The git pre-push hook is configured to run a rustfmt check to ensure that all the Rust files are formatted correctly. If any of the files are not formatted correctly, then the push will fail, and you will need to fix the issue(s) before attempting to push again.
You can optionally skip this hook by including the --no-verify switch (i.e. git push --no-verify)