Authoritative guide for all software-writing agents in this repository
Sign in to like and favorite skills
| Principle | Meaning for agents |
|---|---|
| Data before UI | Treat database schema, migrations, and existing rows as sacred: can be updated, but carefully and structured. |
| Small, safe steps | Every session past v1 is a micro-iteration with its own log, spec delta, and reflection. |
| Design, then develop | Every session both amends the design specs and implements the changes into code. |
| Canadian English | House style for all prose and code. |
| Security first | No plaintext secrets; use environment variables referenced by pattern in |
| Test a lot | Configure solidity-coverage and integration tests to catch bugs early. Use CI workflows to run tests on every pull request. Foundry’s forge coverage is wired via scripts/forge-coverage.sh; keep ≥ 90 % line coverage. |
Source files are organized under the
app/.github/workflows/ # Mandatory - PR template + CI workflows for build, lint, supabase, secret scanning agent-context/ # designs, logs and other context files for developers and agents ├─ session-log.md # Mandatory – append-only per session, new entries at top of file, v ↑ per edit ├─ technical-spec.md # Mandatory – latest technical spec ├─ functional-spec.md # Mandatory – latest functional spec ├─ user-stories.md # Optional – personas & acceptance criteria ├─ app-context.md # Optional – problem, approach, value prop ├─ sql-diff-v{N}.sql # Optional – Auto-generated incremental SQL patches - append-only per session (new entries at top of file) └─ workflow.md # Repetitive per-session checklist app/ # app router components/ # shared components hooks/ # custom React hooks lib/ public/ # static assets to be served scripts/ # helper scripts for env:sync, lint, etc styles/ # global styles supabase/ # latest sql schema (github action runs db pull on PR) test/ README.md # intro to the project and this repo AGENTS.md # this file agent-setup.md # One-time boot-strap guide for agents
Note: If expected files are missing from .github/workflows or from agent-context/ then follow these instructions to create them.
solhintsolidity-lintpnpm lintpnpm lint:ts && pnpm lint:sol.env.example.env.example| Phase | File | Detail |
|---|---|---|
| Bootstrap (first run) | | Creates folders, Husky hooks, CI scaffold, etc. Installs git-moji-cli for commit emojis (optional). |
| Every session | | Mandatory checklist (log, spec update(s), code, summary). |
| Artefact maintenance | Scripts inside | |
| CI Triggers | Pushes to main and all PRs run forge test, forge coverage, pnpm lint, and hardhat size-contracts. |
Agents must read agent-setup.md if artefacts are missing, otherwise follow
workflow.md