Skip to content

Commit 6c38a68

Browse files
committed
docs: Add guidelines for using the agent workspace in AGENTS.md
1 parent 48f6c1b commit 6c38a68

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

AGENTS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,17 @@
3939
## Security and Configuration Tips
4040
- No runtime secrets required. Never execute the target PHP; static analysis only.
4141
- Validate `--path` input and avoid side effects during analysis.
42+
43+
## Agent Workspace (`.codex/`)
44+
- Purpose: A git-ignored workspace at the project root for agent output. Use it freely for investigation notes, scratch files, and work plans.
45+
- Location: `./.codex/` (already listed in `.gitignore`). Do not commit contents.
46+
- Suggested structure:
47+
- `/.codex/plans/`: Work plans, TODOs, execution checklists.
48+
- `/.codex/analysis/`: Investigation notes, findings, benchmarks, quick experiments.
49+
- `/.codex/out/`: Generated artifacts for manual inspection (e.g., temporary diagrams, logs).
50+
- `/.codex/cache/`: Ephemeral cache or intermediate data.
51+
- Naming convention: `YYYYMMDD-HHMMSS-topic.md` (e.g., `20250809-1542-parser-investigation.md`).
52+
- Usage policy:
53+
- Output investigation results and work plans to `.codex/` instead of the tracked repo.
54+
- Keep outputs self-contained and disposable; no assumptions of stability.
55+
- Do not store secrets; avoid side effects beyond this directory.

0 commit comments

Comments
 (0)