23 lines
1.2 KiB
Markdown
23 lines
1.2 KiB
Markdown
# OpenSpec Workflow (Project-Compatible)
|
|
|
|
This repository uses OpenSpec for all proposals, reviews, changes, and specifications. The structure and slash commands are compatible with https://github.com/Fission-AI/OpenSpec.
|
|
|
|
Directory layout
|
|
- `openspec/project.md` — Project conventions, workflow details, and architectural guidelines
|
|
- `openspec/specs/` — Accepted/implemented specifications
|
|
- `openspec/changes/` — Proposals and change cycles (propose → review → apply → archive)
|
|
- `openspec/templates/` — Proposal templates and authoring helpers
|
|
|
|
Lifecycle (every change)
|
|
1) Propose: author a proposal in `openspec/changes/` using the template
|
|
2) Review: async discussion; resolve risks, compliance, and accessibility
|
|
3) Apply: merge and move normative content into `openspec/specs/`
|
|
4) Archive: close the proposal with a link to the applied spec/PR
|
|
|
|
Slash commands (AI-friendly)
|
|
- `/propose` — start a proposal using the template
|
|
- `/review` — request targeted review (compliance, accessibility, security, data, mobile, web)
|
|
- `/apply` — prepare the agreed diff and migration steps
|
|
- `/archive` — mark the proposal as archived with links
|
|
- Additional commands and examples: `openspec/ai-commands.md`
|
|
|