suyiiyii/yq
1
0
Fork 0
mirror of https://github.com/mikefarah/yq.git synced 2026-07-04 11:25:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix AGENTS.md spelling and note spellcheck before PR

Browse Source 
Co-authored-by: Mike Farah <mikefarah@users.noreply.github.com>
This commit is contained in:
Cursor Agent 2026-06-06 06:47:10 +00:00
parent 4ee76205b3
commit 00efd3cc0e
No known key found for this signature in database
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
AGENTS.md
View File

@ -2,6 +2,14 @@
See [agents.md](./agents.md) for contributor workflow (formatting, testing patterns, adding encoders/decoders). See [agents.md](./agents.md) for contributor workflow (formatting, testing patterns, adding encoders/decoders).
Always run the spellcheck before raising a PR:
```bash
bash scripts/spelling.sh
```
This is also included in the full CI pipeline via `make local test`.
## Cursor Cloud specific instructions ## Cursor Cloud specific instructions
### Overview ### Overview
@ -39,7 +47,7 @@ export PATH="$HOME/go/bin:$PATH"
`make local build` runs the full CI chain (format → spelling → gosec → lint → unit tests → build → acceptance). For a faster loop, build with `go build -o yq .` and run `bash scripts/acceptance.sh`. `make local build` runs the full CI chain (format → spelling → gosec → lint → unit tests → build → acceptance). For a faster loop, build with `go build -o yq .` and run `bash scripts/acceptance.sh`.
### Gotchas ### Caveats
- **`make` without `local`** tries Docker/Podman (`Dockerfile.dev`). In Cloud Agent VMs without Docker, always prefix with `make local`. - **`make` without `local`** tries Docker/Podman (`Dockerfile.dev`). In Cloud Agent VMs without Docker, always prefix with `make local`.
- **Spelling step** uses `npx cspell` and may download cspell on first run (network required). - **Spelling step** uses `npx cspell` and may download cspell on first run (network required).