Commit 8df5a02e authored by Wohlgemuth, Jason's avatar Wohlgemuth, Jason
Browse files

docs: Rename coverage make task to cover cause shorter

parent 1b5367ba
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -81,7 +81,7 @@ cargo install cargo-nextest cargo-tarpaulin cargo-audit cargo-auditable
|------|---------|
| Build | `make build` |
| Test | `make test` (or `cargo nextest run --run-ignored all`) |
| Coverage | `make coverage` |
| Coverage | `make cover` |
| Lint/Format | `make lint` |
| Security audit | `make audit` |
| Documentation | `make doc` |
+3 −3
Original line number Diff line number Diff line
@@ -48,7 +48,7 @@ make clean
make doc

# Run tests with coverage
make coverage
make cover

# Security audit
make audit
@@ -143,7 +143,7 @@ cargo nextest run --package acorn-cli commands::check::tests::test_check_command
make test-ci

# With coverage report
make coverage
make cover
# OR
cargo tarpaulin --out lcov --line --skip-clean --no-dead-code --engine llvm
```
@@ -168,7 +168,7 @@ Before submitting changes, verify:
- [ ] Validation: Added appropriate `#[validate(...)]` attributes from `validator` crate
- [ ] CLI output: Uses `Label::*()` from `acorn::util` for consistent styling
- [ ] No new clippy warnings: `cargo clippy --workspace --no-deps --all-targets`
- [ ] Coverage not decreased: `make coverage` (if applicable)
- [ ] Coverage not decreased: `make cover` (if applicable)

## Project Structure

+2 −2
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ If you would like to generously provide a pull request to correct a verified iss
| Lint **ALL** code                        | `make lint`        |
| Lint **ALL** code and run **ALL** tests  | `make lint test`   |
| Run **ALL** tests                        | `make test`        |
| Run **ALL** tests with coverage          | `make coverage`    |
| Run **ALL** tests with coverage          | `make cover`       |
| Run security audit on dependencies       | `make audit`       |
| Generate documentation                   | `make doc`         |
| Generate CHANGELOG<sup>[[1]](#1)</sup>   | `make changelog`   |
@@ -50,7 +50,7 @@ If you would like to generously provide a pull request to correct a verified iss
## Project Standards
- Running `make lint` should not introduce any new lint and all format results should be included in proposed changes
- Running `make test` should not have any failures
- Running `make coverage` should not decrease coverage
- Running `make cover` should not decrease coverage
- Exceptions to any of these standards should be supported by strong reasoning and sufficient effort

## Running ACORN tasks from source
+2 −2
Original line number Diff line number Diff line
@@ -43,7 +43,7 @@ changelog-release:
	@git pull origin main --tags
	@git-cliff --output CHANGELOG.md --gitlab-token ${GITLAB_TOKEN} --latest

coverage: clean lint
cover: clean lint
	@cargo tarpaulin --out lcov --line --skip-clean --no-dead-code --engine llvm

doc:
@@ -196,7 +196,7 @@ TASKS = \
	changelog \
	changelog-release \
	clean \
	coverage \
	cover \
	doc \
	lint \
	publish-book \