Skip to content

Commit f99b45f

Browse files
committed
Improve AGENTS.md
1 parent dc35828 commit f99b45f

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

AGENTS.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,15 @@ This repository contains the public scripts for Simple Analytics. When making ch
66

77
- Use **Node.js 22.16** (see `.nvmrc`).
88
- Run `npm run build` to compile the scripts. This generates the files in `dist/` which should be committed.
9-
- Format code with Prettier before committing. You can run `npx prettier -w .`.
10-
- Execute `npm run test:unit` to run the unit tests.
9+
- Format code with Prettier before committing. You can run `npx prettier -w .` or validate with `npm run prettier`.
10+
11+
## Testing
12+
13+
- Execute `npm run test:unit` to run the unit tests
14+
- When adding a new feature or fixing a bug, please add a test.
15+
- For every change, run `npm run build` to ensure the test uses the latest compiled version.
16+
- Ignore most files in the `dist/` directory when checking for diffs, just check `dist/latest/latest.dev.js` and `dist/latest/auto-events.js` (whichever is relevant).
17+
- Only tests in `test/unit/` are relevant for the AI and agents (it can run without internet access).
1118

1219
## References
1320

0 commit comments

Comments
 (0)