| |
|
| |
Patch formatting follows the same rules as commit formatting. See below.
|
| |
|
| - |
### Git hooks & Task runner
|
| + |
### Developer boostrap
|
| |
|
| - |
We use [`just >= v1.49.0`](https://just.systems/) as our task runner. You can see all available commands by running `just` or `just --list` in the repository root.
|
| + |
To bootstrap our development environment for this repository, please
|
| + |
run the following command:
|
| + |
|
| + |
$ dev/bootstrap.sh
|
| |
|
| - |
If you are not using Nix (which sets up hooks automatically), you should install the local git hooks:
|
| + |
It will set up (or append to, if it already exists) `.envrc`, as well
|
| + |
as install git hooks if you have `just` installed (if not, you will be
|
| + |
asked to install it and re-run this script).
|
| |
|
| - |
$ just install-hooks
|
| + |
### Task runner
|
| |
|
| - |
These hooks will run formatting, linting, and spelling checks on `pre-commit` and `pre-push`. For security, our hooks are copied rather than symlinked. If you check out a branch that modifies sensitive files (like `build.rs` or `justfile`), the hook will pause and ask for your confirmation before executing any code.
|
| + |
We use [`just >= v1.49.0`](https://just.systems/) as our task runner. You can see all available commands by running `just` or `just --list` in the repository root.
|
| |
|
| |
### Linting & formatting
|
| |
|