Skip to content

Commit e7a6993

Browse files
committed
Add AGENTS.md guidance for coding agents
1 parent aa7f4ca commit e7a6993

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

AGENTS.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# AGENTS.md
2+
3+
## Repo Snapshot
4+
- Repository: `jtgsystems/Phone-Control-Project`
5+
- Default branch: `main`
6+
- Visibility: `public`
7+
- Summary: Phone control system - Remote device management & automation
8+
- Detected stack: Node.js, Python
9+
10+
## Read First
11+
- `README.md`
12+
- `CLAUDE.md`
13+
- `package.json`
14+
- `requirements.txt`
15+
- `.github/workflows/`
16+
17+
## Key Paths
18+
- `src/`
19+
- `Software/`
20+
21+
## Working Rules
22+
- Keep changes focused on the task and match the existing file layout and naming patterns.
23+
- Update tests and docs when behavior changes or public interfaces move.
24+
- Do not commit secrets, credentials, ad-hoc exports, or large generated artifacts unless the repository already tracks them intentionally.
25+
- Prefer the existing automation and CI workflow over one-off commands when both paths exist.
26+
- Legacy agent guidance exists in `CLAUDE.md`; keep it aligned with `AGENTS.md` if those files remain in use.
27+
28+
## Verified Commands
29+
- Install: `npm install`
30+
- Dev: `npm run dev`
31+
- Build: `npm run build`
32+
- Test: `npm test`
33+
34+
## Change Checklist
35+
- Run the relevant tests or static checks for the files you changed before finishing.
36+
- Keep human-facing docs aligned with behavior changes.
37+
- If the repo has specialized areas later, add nested `AGENTS.md` files close to that code instead of overloading the root file.
38+
39+
## Notes
40+
- CI source of truth lives in `.github/workflows/`.
41+
42+
This file should stay short, specific, and current. Update it whenever the repo's real setup or verification steps change.

0 commit comments

Comments
 (0)