mirror of
https://github.com/Fission-AI/OpenSpec.git
synced 2026-09-14 20:16:53 +08:00
Tabish Bidiwale
30 lines
1.1 KiB
Markdown
30 lines
1.1 KiB
Markdown
# Update Agent Instruction File Name
|
|
|
|
## Problem
|
|
The agent instructions live in `openspec/README.md`, which clashes with conventional project README usage and creates confusion for tooling and contributors.
|
|
|
|
## Solution
|
|
Rename the agent instruction file to `openspec/AGENTS.md` and update OpenSpec tooling to use the new filename:
|
|
- `openspec init` generates `AGENTS.md` instead of `README.md`
|
|
- Templates and code reference `AGENTS.md`
|
|
- Specifications and documentation are updated accordingly
|
|
|
|
## Benefits
|
|
- Clear separation from project documentation
|
|
- Consistent naming with other agent instruction files
|
|
- Simplifies tooling and project onboarding
|
|
|
|
## Implementation
|
|
- Rename instruction file and template
|
|
- Update CLI commands (`init`, `update`) to read/write `AGENTS.md`
|
|
- Adjust specs and documentation to reference the new path
|
|
|
|
## Risks
|
|
- Existing projects may still rely on `README.md`
|
|
- Tooling may miss lingering references to the old filename
|
|
|
|
## Success Metrics
|
|
- `openspec init` creates `openspec/AGENTS.md`
|
|
- `openspec update` refreshes `AGENTS.md`
|
|
- All specs reference `openspec/AGENTS.md`
|