Skip to content

docs: state that coverage is gated #438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
retr0h merged 1 commit into from
Aug 15, 2026
Merged

docs: state that coverage is gated #438

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/docs/sidebar/development/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,16 @@ just go::unit # Run unit tests only
just go::unit-int # Run integration tests (requires running osapi)
```

Coverage is gated at 99.9%. `just test` fails if total coverage drops below it,
so a change that adds untested code fails locally and in CI:

```bash
just go::unit-cov-check # Report coverage and fail below the target
```

The target is declared in `.github/codecov.yml` and in the shared `go` justfile
module — change both together.

Unit tests should follow the Go convention of being located in a file named
`*_test.go` in the same package as the code being tested. Integration tests are
located in `test/integration/` and use a `//go:build integration` tag. They
Expand Down