Skip to content

Commit

Permalink
Use relative file paths in documentation anchors
Browse files Browse the repository at this point in the history
  • Loading branch information
cooperwalbrun committed Sep 15, 2024
1 parent c1233f6 commit 16776cd
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ cargo make run # Run the application
cargo make test # Run all unit tests
cargo make test-coverage # Run all unit tests and write a code coverage report to STDOUT
cargo make test-coverage-ci # Run all unit tests and write a code coverage report to a text file in LCOV format
cargo make format # Formats (rewrites) every applicable file in the project
cargo make format-ci # Formats (report only) every applicable file in the project
cargo make lint # Lints (report only) every applicable file in the project
cargo make lint-watch # Lints (report only) every applicable file in the project and re-lints whenever files change
cargo make format # Format (rewrite) every applicable file in the project
cargo make format-ci # Format (report only) every applicable file in the project
cargo make lint # Lint (report only) every applicable file in the project
cargo make lint-watch # Lint (report only) every applicable file in the project and re-lints whenever files change
```

`cargo-make` will automatically fetch crates and toolchain components as needed when you run these
Expand All @@ -40,10 +40,10 @@ commands. Between this and what is defined in `Cargo.toml`, you should never nee

This project uses [rustfmt](https://github.com/rust-lang/rustfmt) to handle formatting, and
contributions to its code are expected to be formatted with `rustfmt` (within reason) using the
settings in [rustfmt.toml](rustfmt.toml).
settings in [rustfmt.toml](./rustfmt.toml).

This project uses [rust-clippy](https://github.com/rust-lang/rust-clippy) to handle linting, and
contributions are expected to be checked using the settings in [clippy.toml](clippy.toml).
contributions are expected to be checked using the settings in [clippy.toml](./clippy.toml).

>Note: `rustfmt` and `rust-clippy` each have many built-in defaults that will be used in the
>absence of a corresponding rule in `rustfmt.toml`/`clippy.toml`.
Expand Down

0 comments on commit 16776cd

Please sign in to comment.