harden terminal view, add $impeccable design docs, update AGENTS.md
This commit is contained in:
parent
1089174264
commit
9644e9ceef
10 changed files with 1716 additions and 42 deletions
106
AGENTS.md
106
AGENTS.md
|
|
@ -69,17 +69,103 @@ Working style that avoids common problems here:
|
|||
- Keep `.env` aligned with `.env.example`; adapters default to synthetic modes for local development.
|
||||
- Dev runners persist child PID state in `.tmp/`; if a previous run crashed, restart via the standard `bun run dev*` commands so stale processes are cleaned up.
|
||||
|
||||
Always do the following when you finish a task and make a commit:
|
||||
## Required Turn Documentation
|
||||
|
||||
At the end of every completed implementation task, before final handoff, create a user-readable HTML document describing the work.
|
||||
|
||||
This documentation is mandatory whenever code, configuration, tests, or project files were changed.
|
||||
|
||||
### Location
|
||||
|
||||
Save the document in:
|
||||
|
||||
```text
|
||||
docs/turns/
|
||||
```
|
||||
|
||||
Use a clear timestamped filename:
|
||||
|
||||
```text
|
||||
docs/turns/YYYY-MM-DD-short-task-name.html
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```text
|
||||
docs/turns/2026-05-14-add-market-replay-controls.html
|
||||
```
|
||||
|
||||
### Format
|
||||
|
||||
Use the impeccable skill to structure the document as clean, readable HTML.
|
||||
|
||||
If the impeccable skill is unavailable, still create a well-structured standalone HTML file with:
|
||||
|
||||
- A concise summary at the top
|
||||
- A detailed explanation of what changed
|
||||
- Relevant context or background
|
||||
- Specific code snippets or examples when helpful
|
||||
- Issues, limitations, tradeoffs, or mitigations
|
||||
- Validation performed, including tests, builds, linters, or manual checks
|
||||
- Any remaining follow-up work, with corresponding Beads issue IDs when applicable
|
||||
|
||||
### Required Sections
|
||||
|
||||
Each turn document must include these sections:
|
||||
|
||||
1. **Summary**
|
||||
2. **Changes Made**
|
||||
3. **Context**
|
||||
4. **Important Implementation Details**
|
||||
5. **Validation**
|
||||
6. **Issues, Limitations, and Mitigations**
|
||||
7. **Follow-up Work**
|
||||
|
||||
### Completion Rule
|
||||
|
||||
A task is not complete until:
|
||||
|
||||
1. The Beads workflow is updated
|
||||
2. The turn document is created in `docs/turns`
|
||||
3. Relevant quality gates have passed or failures are documented
|
||||
4. Changes are committed
|
||||
5. `bd dolt push` succeeds
|
||||
6. `git push` succeeds
|
||||
7. `git status` shows the branch is up to date with origin
|
||||
|
||||
For trivial changes, the document may be brief, but it must still exist and clearly explain what changed and how it was validated.
|
||||
|
||||
## Plan Mode Documentation
|
||||
|
||||
When working in plan mode, do not modify implementation files.
|
||||
|
||||
At the end of plan mode, provide a concise summary of the plan and ask the user whether they want to proceed with implementation.
|
||||
|
||||
If the user asks to save the plan, create a user-readable HTML plan document in:
|
||||
|
||||
```text
|
||||
docs/plans/
|
||||
```
|
||||
|
||||
Use a clear timestamped filename:
|
||||
|
||||
```text
|
||||
docs/plans/YYYY-MM-DD-short-plan-name.html
|
||||
```
|
||||
|
||||
The plan document should be labeled clearly as a plan and should include:
|
||||
|
||||
1. **Plan Summary**
|
||||
2. **Goals**
|
||||
3. **Proposed Changes**
|
||||
4. **Relevant Context**
|
||||
5. **Implementation Steps**
|
||||
6. **Risks, Limitations, and Mitigations**
|
||||
7. **Open Questions**
|
||||
|
||||
Always do the following when you finish a task, finish the beads workflow and and make a commit:
|
||||
- Document the changes in a user-readable format
|
||||
- Use the impeccable skill to structure the document as HTML
|
||||
- Create a clear, concise summary of the changes at the top, followed by a detailed description of the changes, including any relevant context or background as well as specific code snippets or examples.
|
||||
- Note any relevant issues or limitations that were addressed or mitigated by the changes.
|
||||
- The document should be stored in the `docs/turns` directory.
|
||||
|
||||
Always do the following when you finish a task and make a commit:
|
||||
- Give a conscise summary of the plan and the changes made.
|
||||
- Use the impeccable skill to structure the document as HTML
|
||||
- Create a clear, concise summary of the changes at the top, followed by a detailed description of the changes, including any relevant context or background as well as specific code snippets or examples.
|
||||
- Note any relevant issues or limitations that would be addressed or mitigated by the changes.
|
||||
- The document should be stored in the `docs/plans` directory.
|
||||
- It should be labeled as a plan with a brief description of the changes.
|
||||
- The HTML file should be stored in the `docs/turns` directory. It should include the current date and time, as well as a brief explanation of changes. e.g. docs/turns/YYYY-MM-DD-{description}.html
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue