Skip to content

docs: add pre-commit/pre-PR gate mapped to CI #7

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
paustin01 merged 1 commit into from
Jul 19, 2026
Merged

docs: add pre-commit/pre-PR gate mapped to CI #7

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
15 changes: 15 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,21 @@ just ci # fmt -> tests -> lint -> build
Order: `--config` flag → `$HOME/.versioner/config.yaml` → `./config.yaml`.
Env prefix: `VERSIONER_` (e.g. `VERSIONER_API_KEY`).

## Pre-commit / pre-PR gate (required)

Mirrors GitHub Actions `test.yml` on PRs to `main`/`develop`: **test** (`go test -race`), **lint** (golangci-lint), **matrix build**.

| When | Command | Notes |
|------|---------|--------|
| **Final handoff (required)** | `just ci` | `fmt` → `run_tests` → `lint` → `build` |
| Closest to CI tests | `go test -v -race ./...` | CI adds `-race`; `just run_tests` is plain `go test -v` |
| Lint only | `just lint` | CI runs golangci-lint-action |

**Rules for agents**
1. Run **`just ci`** before commit/push (or at least tests + lint + build if `ci` skips lint when golangci-lint missing — install linter rather than skip).
2. Prefer `go test -v -race ./...` once before handoff if `just ci` does not pass `-race`.
3. Note commands + results on the card/PR.

## Local conventions

- Follow existing patterns
Expand Down
Loading