mirror of
https://github.com/Fission-AI/OpenSpec.git
synced 2026-10-02 05:24:34 +08:00
docs(openspec): align requirements with current behavior (#1919)
* docs(openspec): correct 4 requirements that the code has outgrown
- cli-artifact-workflow/experimental-isolation#8: Updated the file path in the Single file implementation scenario to match the actual command location (src/commands/workflow/status.ts).
- cli-init/exit-codes#7: Updated the exit code for user-cancelled operations from 3 to 130 to match implementation.
- openspec-conventions/header-based-requirement-identification#6: Updated the normalization rule to remove a trailing run of '#' characters and surrounding spaces before trimming.
- cli-config/profile-configuration-flow#9: Changed the first action option label from 'Change delivery + workflows' to 'Delivery and workflows' to match the code.
None of these reduce what a requirement demands.
Scanned at bae58cf614 by openai/gpt-5-mini-2025-08-07.
* docs(openspec): harden drift corrections
* docs(openspec): clarify header normalization
---------
Co-authored-by: openspec-cloud[bot] <311461291+openspec-cloud[bot]@users.noreply.github.com>
Co-authored-by: Clay Good <hi@claygood.com>
This commit is contained in:
co-authored by
Clay Good
parent
9557b43aaf
commit
5fe58590ba
@@ -183,17 +183,6 @@ The system SHALL provide consistent output formatting.
|
||||
- **WHEN** loading change state takes time
|
||||
- **THEN** the system displays a spinner during loading
|
||||
|
||||
### Requirement: Experimental Isolation
|
||||
The system SHALL implement artifact workflow commands in isolation for easy removal.
|
||||
|
||||
#### Scenario: Single file implementation
|
||||
- **WHEN** artifact workflow feature is implemented
|
||||
- **THEN** all commands are in `src/commands/artifact-workflow.ts`
|
||||
|
||||
#### Scenario: Help text marking
|
||||
- **WHEN** user runs `--help` on any artifact workflow command
|
||||
- **THEN** help text indicates the command is experimental
|
||||
|
||||
### Requirement: Schema Apply Block
|
||||
|
||||
The system SHALL support an `apply` block in schema definitions that controls when and how implementation begins.
|
||||
|
||||
@@ -182,9 +182,9 @@ The `openspec config profile` command SHALL provide an action-first interactive
|
||||
|
||||
- **WHEN** user runs `openspec config profile` interactively
|
||||
- **THEN** the first prompt SHALL offer:
|
||||
- `Change delivery + workflows`
|
||||
- `Change delivery only`
|
||||
- `Change workflows only`
|
||||
- `Delivery and workflows`
|
||||
- `Delivery only`
|
||||
- `Workflows only`
|
||||
- `Keep current settings (exit)`
|
||||
|
||||
#### Scenario: Delivery prompt marks current selection
|
||||
|
||||
@@ -99,8 +99,8 @@ Requirement headers SHALL serve as unique identifiers for programmatic matching
|
||||
|
||||
- **WHEN** processing delta changes
|
||||
- **THEN** use the `### Requirement: [Name]` header as the unique identifier
|
||||
- **AND** match using normalized headers: `normalize(header) = trim(header)`
|
||||
- **AND** compare headers with case-sensitive equality after normalization
|
||||
- **AND** strip a closing run of `#` characters when a space or tab precedes it and only spaces or tabs follow it, then trim surrounding whitespace
|
||||
- **AND** compare normalized requirement names with case-sensitive equality
|
||||
|
||||
#### Scenario: Handling requirement renames
|
||||
|
||||
|
||||
Reference in New Issue
Block a user