wehub-resource-sync
0d3cb498a3
CI / Shell Format Check (push) Has been cancelled
CI / Check Ruby (3.4) (push) Has been cancelled
CI / CI Config (push) Has been cancelled
CI / Test on Node ${{ matrix.node }} and ${{ matrix.os }}${{ matrix.shard && format(' (shard {0}/3)', matrix.shard) || '' }} (push) Has been cancelled
CI / Build on Node ${{ matrix.node }} (push) Has been cancelled
CI / Style Check (push) Has been cancelled
CI / Generate Assets (push) Has been cancelled
CI / Check Python (3.14) (push) Has been cancelled
CI / Check Python (3.9) (push) Has been cancelled
CI / Build Docs (push) Has been cancelled
CI / Code Scan Action (push) Has been cancelled
CI / Site tests (push) Has been cancelled
CI / webui tests (push) Has been cancelled
CI / Run Integration Tests (push) Has been cancelled
CI / Run Smoke Tests (push) Has been cancelled
CI / Go Tests (push) Has been cancelled
CI / Share Test (push) Has been cancelled
CI / Redteam (Production API) (push) Has been cancelled
CI / Redteam (Staging API) (push) Has been cancelled
CI / GitHub Actions Lint (push) Has been cancelled
CI / Check Ruby (3.0) (push) Has been cancelled
release-please / release-please (push) Has been cancelled
release-please / build (push) Has been cancelled
release-please / publish-npm (push) Has been cancelled
release-please / publish-npm-backfill (push) Has been cancelled
release-please / docker (push) Has been cancelled
release-please / publish-code-scan-action (push) Has been cancelled
release-please / attest-code-scan-action (push) Has been cancelled
Deploy local.promptfoo.app / Deploy to Cloudflare Pages (push) Has been cancelled
Test and Publish Multi-arch Docker Image / test (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-amd64 platform:linux/amd64 runner:ubuntu-latest]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / build-docker-and-push-digests (map[digest-suffix:linux-arm64 platform:linux/arm64 runner:ubuntu-24.04-arm]) (push) Has been cancelled
Test and Publish Multi-arch Docker Image / merge-docker-digests (push) Has been cancelled
Test and Publish Multi-arch Docker Image / Attest Multi-arch Image (push) Has been cancelled
Validate Renovate Config / Validate Renovate Configuration (push) Has been cancelled
28 lines
1.0 KiB
Markdown
28 lines
1.0 KiB
Markdown
# Agent Documentation
|
|
|
|
Guidance for AI agents editing the reusable docs in `docs/agents/`.
|
|
|
|
## Rules
|
|
|
|
- When changing PR workflow guidance, update both `docs/agents/pr-conventions.md` and
|
|
the root `AGENTS.md` "Pull Request Creation" section in the same PR.
|
|
- When changing dependency workflow guidance, keep
|
|
`docs/agents/dependency-management.md` aligned with the root npm/audit guidance.
|
|
- Do not introduce hard-coded local env-file requirements into generic eval commands.
|
|
Use `--env-file .env` only when credentials are needed and the file exists.
|
|
- Do not claim that eval exit code 0 means all test cases passed unless the text
|
|
accounts for `PROMPTFOO_PASS_RATE_THRESHOLD`.
|
|
- Verify implementation claims against source before documenting paths, defaults, or
|
|
environment variables, and avoid machine-specific paths.
|
|
- Prefer concrete command examples over broad advice, and avoid duplicating long
|
|
guidance from root docs.
|
|
|
|
## Validation
|
|
|
|
For docs-only edits here, run:
|
|
|
|
```bash
|
|
npm run f
|
|
git diff --check
|
|
```
|