Skip to content

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

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 #6

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
16 changes: 16 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,22 @@ just ci # format → lint → build → test
- `src/types.ts` — payloads/responses
- `action.yml` — inputs/outputs

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

Mirrors GitHub Actions `ci.yml` on PRs: lint, test, build, and **committed `dist/` must match build**.

| When | Command | Notes |
|------|---------|--------|
| **Final handoff (required)** | `just ci` | format → lint → build → tests |
| CI-equivalent | `npm ci && npm run lint && npm test && npm run build` then ensure `dist/` clean | CI also fails if dist dirty / out of date |
| After source changes | `just build` and **commit `dist/`** | required for Action consumers |

**Rules for agents**
1. Run **`just ci`** before commit/push.
2. If `src/` changed, rebuild and **include `dist/`** in the commit (excluding flaky absolute-path `.map` noise if tooling touches them — CI ignores `.map` diffs in one check but still requires up-to-date bundle).
3. Do not hand off with an outdated `dist/`.
4. Note commands + results on the card/PR.

## Local conventions

- Follow existing patterns
Expand Down
Loading