mirror of
https://github.com/Fission-AI/OpenSpec.git
synced 2026-09-14 20:16:53 +08:00
Tabish Bidiwale
72 lines
2.8 KiB
Markdown
72 lines
2.8 KiB
Markdown
## MODIFIED Requirements
|
|
### Requirement: AI Tool Configuration
|
|
The command SHALL configure AI coding assistants with OpenSpec instructions based on user selection.
|
|
|
|
#### Scenario: Prompting for AI tool selection
|
|
|
|
- **WHEN** run
|
|
- **THEN** prompt user to select AI tools to configure:
|
|
- Claude Code (✅ OpenSpec custom slash commands available)
|
|
- Cursor (✅ OpenSpec custom slash commands available)
|
|
- AGENTS.md (works with Codex, Amp, Copilot, …)
|
|
|
|
### Requirement: AI Tool Configuration Details
|
|
The command SHALL properly configure selected AI tools with OpenSpec-specific instructions using a marker system.
|
|
|
|
#### Scenario: Configuring Claude Code
|
|
|
|
- **WHEN** Claude Code is selected
|
|
- **THEN** create or update `CLAUDE.md` in the project root directory (not inside openspec/)
|
|
|
|
#### Scenario: Configuring AGENTS standard
|
|
|
|
- **WHEN** the AGENTS.md standard is selected
|
|
- **THEN** create or update `AGENTS.md` in the project root directory (not inside openspec/)
|
|
|
|
#### Scenario: Creating new CLAUDE.md
|
|
|
|
- **WHEN** CLAUDE.md does not exist
|
|
- **THEN** create new file with OpenSpec content wrapped in markers:
|
|
```markdown
|
|
<!-- OPENSPEC:START -->
|
|
# OpenSpec Project
|
|
|
|
This document provides instructions for AI coding assistants on how to use OpenSpec conventions for spec-driven development. Follow these rules precisely when working on OpenSpec-enabled projects.
|
|
|
|
This project uses OpenSpec for spec-driven development. Specifications are the source of truth.
|
|
|
|
See @openspec/AGENTS.md for detailed conventions and guidelines.
|
|
<!-- OPENSPEC:END -->
|
|
```
|
|
|
|
#### Scenario: Creating new AGENTS.md
|
|
|
|
- **WHEN** AGENTS.md does not exist in the project root
|
|
- **THEN** create new file with OpenSpec content wrapped in markers using the same template as CLAUDE.md
|
|
|
|
#### Scenario: Updating existing CLAUDE.md
|
|
|
|
- **WHEN** CLAUDE.md already exists
|
|
- **THEN** preserve all existing content
|
|
- **AND** insert OpenSpec content at the beginning of the file using markers
|
|
- **AND** ensure markers don't duplicate if they already exist
|
|
|
|
#### Scenario: Updating existing AGENTS.md
|
|
|
|
- **WHEN** AGENTS.md already exists in the project root
|
|
- **THEN** preserve all existing content
|
|
- **AND** ensure the OpenSpec-managed block at the beginning of the file is refreshed without duplicating markers
|
|
|
|
#### Scenario: Managing content with markers
|
|
|
|
- **WHEN** using the marker system
|
|
- **THEN** use `<!-- OPENSPEC:START -->` to mark the beginning of managed content
|
|
- **AND** use `<!-- OPENSPEC:END -->` to mark the end of managed content
|
|
- **AND** allow OpenSpec to update its content without affecting user customizations
|
|
- **AND** preserve all content outside the markers intact
|
|
|
|
WHY use markers:
|
|
- Users may have existing CLAUDE.md or AGENTS.md instructions they want to keep
|
|
- OpenSpec can update its instructions in future versions
|
|
- Clear boundary between OpenSpec-managed and user-managed content
|