Skip to content

Commit d71009b

Browse files
committed
Format the command list in CONTRIBUTING.md as a markdown table
1 parent fb91499 commit d71009b

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

CONTRIBUTING.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,19 @@ cargo install cargo-make
1919

2020
With `cargo-make`, all of this project's commands will become available to you:
2121

22-
```bash
23-
cargo make clean # Clean up temporary files
24-
cargo make build # Lint and build the project
25-
cargo make run # Run the application
26-
cargo make test # Run all unit tests
27-
cargo make test-coverage # Run all unit tests and write a code coverage report to STDOUT
28-
cargo make test-coverage-ci # Run all unit tests and write a code coverage report to a text file in LCOV format
29-
cargo make format # Format (rewrite) every applicable file in the project
30-
cargo make format-ci # Format (report only) every applicable file in the project
31-
cargo make lint # Lint (report only) every applicable file in the project
32-
cargo make lint-watch # Lint (report only) every applicable file in the project and re-lints whenever files change
33-
cargo make dependency-report # Show outdated dependencies in the project, if any
34-
```
22+
| Command | Description/Function |
23+
|--------------------------------|--------------------------------------------------------------------------------------------|
24+
| `cargo make clean` | Clean up temporary files |
25+
| `cargo make build` | Lint and build the project |
26+
| `cargo make run` | Run the application |
27+
| `cargo make test` | Run all unit tests |
28+
| `cargo make test-coverage` | Run all unit tests and write a code coverage report to STDOUT |
29+
| `cargo make test-coverage-ci` | Run all unit tests and write a code coverage report to a text file in LCOV format |
30+
| `cargo make format` | Format (rewrite) every applicable file in the project |
31+
| `cargo make format-ci` | Format (report only) every applicable file in the project |
32+
| `cargo make lint` | Lint (report only) every applicable file in the project |
33+
| `cargo make lint-watch` | Lint (report only) every applicable file in the project and re-lints whenever files change |
34+
| `cargo make dependency-report` | Show outdated dependencies in the project, if any |
3535

3636
`cargo-make` will automatically fetch crates and toolchain components as needed when you run these
3737
commands. Between this and what is defined in `Cargo.toml`, you should never need to issue a

0 commit comments

Comments
 (0)