Skip to content

docs: add repository agent instructions #16

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
0xSachinK wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add repository agent instructions #16

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
@@ -0,0 +1,16 @@
# Agent instructions

This repository owns the vault metadata list and its JSON schema. Read
`README.md`, `vault-list.json`, and `schema/vault-list.schema.json` before editing.

- Preserve the schema, unique vault identifiers, chain/address relationships,
and the documented listing policy. A metadata entry does not prove a vault's
current onchain state, safety, or performance.
- Verify any added or changed vault against current chain evidence. Do not
invent rates, fees, payment methods, volume, or marketing claims.
- Use the committed npm lockfile and run `npm run validate` for list/schema
changes. Include the relevant logo assets when adding a listing.
- Registry changes do not authorize contract calls, funding, or deployment.
Keep credentials and private customer information out of metadata.
- Make a focused branch and PR. Documentation-only edits need reference checks
and `git diff --check`; no chain transaction is required for validation.