Skip to content

docs: add repository agent instructions #19

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

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
18 changes: 18 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Agent instructions

This repository owns the Telegram escrow/intent tracker and notification bot.
Read `README.md`, `package.json`, and the relevant event handlers before editing.

- Use Node >=22 and the committed npm lockfile. `npm run check` validates
syntax; `npm test` runs the repository tests.
- Keep event decoding and contract selection aligned with the actual ABI and
target deployment. Do not infer live contract activation from a README.
- Preserve reconnect behavior, delivery deduplication, and persisted user
subscriptions. Use mocked transports for routine tests.
- Starting the bot can connect to live RPC/Supabase and send Telegram messages.
Live messaging, production deployment, and database changes require explicit
authorization; they are not part of ordinary test execution.
- Never print bot tokens, credential-bearing RPC URLs, chat identifiers, or
customer data. Keep local environment files untracked.
- Work in an isolated branch and open a focused PR. Documentation-only edits
need reference checks and `git diff --check`, without starting the bot.