Skip to content

docs: add verification evidence guidance #220

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

Open
EmersonBraun wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

docs: add verification evidence guidance #220

Show file tree
Hide file tree
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
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ Below is a minimal example of an AGENTS.md file:
- After moving files or changing imports, run `pnpm lint --filter <project_name>` to be sure ESLint and TypeScript rules still pass.
- Add or update tests for the code you change, even if nobody asked.

## Verification evidence
- Run every command you cite from a clean checkout when practical.
- In the PR description, list the exact commands you ran and whether they passed.
- If a check could not run, say why and what remains unverified.
- Do not claim a check passed based only on reading the code or another agent's report.

## PR instructions
- Title format: [<project_name>] <Title>
- Always run `pnpm lint` and `pnpm test` before committing.
Expand Down
6 changes: 6 additions & 0 deletions components/CodeExample.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,12 @@ name>"\`.
<project_name>\` to be sure ESLint and TypeScript rules still pass.
- Add or update tests for the code you change, even if nobody asked.

## Verification evidence
- Run every command you cite from a clean checkout when practical.
- In the PR description, list the exact commands you ran and whether they passed.
- If a check could not run, say why and what remains unverified.
- Do not claim a check passed based only on reading the code or another agent's report.

## PR instructions
- Title format: [<project_name>] <Title>
- Always run \`pnpm lint\` and \`pnpm test\` before committing.`;
Expand Down