-
Notifications
You must be signed in to change notification settings - Fork 975
feat: restructure schemas as directories with templates #411
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
TabishB
wants to merge
1
commit into
main
Choose a base branch
from
feat/restructure-schema-directories
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| name: spec-driven | ||
| version: 1 | ||
| description: Default OpenSpec workflow - proposal → specs → design → tasks | ||
| artifacts: | ||
| - id: proposal | ||
| generates: proposal.md | ||
| description: Initial proposal document outlining the change | ||
| template: proposal.md | ||
| requires: [] | ||
| - id: specs | ||
| generates: "specs/*.md" | ||
| description: Detailed specifications for the change | ||
| template: spec.md | ||
| requires: | ||
| - proposal | ||
| - id: design | ||
| generates: design.md | ||
| description: Technical design document with implementation details | ||
| template: design.md | ||
| requires: | ||
| - proposal | ||
| - id: tasks | ||
| generates: tasks.md | ||
| description: Implementation tasks derived from specs and design | ||
| template: tasks.md | ||
| requires: | ||
| - specs | ||
| - design |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| ## Context | ||
|
|
||
| <!-- Background and current state --> | ||
|
|
||
| ## Goals / Non-Goals | ||
|
|
||
| **Goals:** | ||
| <!-- What this design aims to achieve --> | ||
|
|
||
| **Non-Goals:** | ||
| <!-- What is explicitly out of scope --> | ||
|
|
||
| ## Decisions | ||
|
|
||
| <!-- Key design decisions and rationale --> | ||
|
|
||
| ## Risks / Trade-offs | ||
|
|
||
| <!-- Known risks and trade-offs --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ## Why | ||
|
|
||
| <!-- Explain the motivation for this change --> | ||
|
|
||
| ## What Changes | ||
|
|
||
| <!-- Describe what will change --> | ||
|
|
||
| ## Impact | ||
|
|
||
| <!-- List affected areas --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| ## ADDED Requirements | ||
|
|
||
| ### Requirement: <!-- requirement name --> | ||
| <!-- requirement text --> | ||
|
|
||
| #### Scenario: <!-- scenario name --> | ||
| - **WHEN** <!-- condition --> | ||
| - **THEN** <!-- expected outcome --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| ## 1. <!-- Task Group Name --> | ||
|
|
||
| - [ ] 1.1 <!-- Task description --> | ||
| - [ ] 1.2 <!-- Task description --> | ||
|
|
||
| ## 2. <!-- Task Group Name --> | ||
|
|
||
| - [ ] 2.1 <!-- Task description --> | ||
| - [ ] 2.2 <!-- Task description --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| name: tdd | ||
| version: 1 | ||
| description: Test-driven development workflow - tests → implementation → docs | ||
| artifacts: | ||
| - id: spec | ||
| generates: spec.md | ||
| description: Feature specification defining requirements | ||
| template: spec.md | ||
| requires: [] | ||
| - id: tests | ||
| generates: "tests/*.test.ts" | ||
| description: Test files written before implementation | ||
| template: test.md | ||
| requires: | ||
| - spec | ||
| - id: implementation | ||
| generates: "src/*.ts" | ||
| description: Implementation code to pass the tests | ||
| template: implementation.md | ||
| requires: | ||
| - tests | ||
| - id: docs | ||
| generates: "docs/*.md" | ||
| description: Documentation for the implemented feature | ||
| template: docs.md | ||
| requires: | ||
| - implementation | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| ## Overview | ||
|
|
||
| <!-- Feature overview --> | ||
|
|
||
| ## Getting Started | ||
|
|
||
| <!-- Quick start guide --> | ||
|
|
||
| ## Examples | ||
|
|
||
| <!-- Code examples --> | ||
|
|
||
| ## Reference | ||
|
|
||
| <!-- API reference or additional details --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ## Implementation Notes | ||
|
|
||
| <!-- Technical implementation details --> | ||
|
|
||
| ## API | ||
|
|
||
| <!-- Public API documentation --> | ||
|
|
||
| ## Usage | ||
|
|
||
| <!-- Usage examples --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ## Feature: <!-- feature name --> | ||
|
|
||
| <!-- Feature description --> | ||
|
|
||
| ## Requirements | ||
|
|
||
| <!-- List of requirements --> | ||
|
|
||
| ## Acceptance Criteria | ||
|
|
||
| <!-- List of acceptance criteria --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| ## Test Plan | ||
|
|
||
| <!-- Describe the testing strategy --> | ||
|
|
||
| ## Test Cases | ||
|
|
||
| ### <!-- Test case name --> | ||
|
|
||
| - **Given:** <!-- preconditions --> | ||
| - **When:** <!-- action --> | ||
| - **Then:** <!-- expected result --> |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Description doesn't mention the initial spec step.
The description says "tests → implementation → docs" but the workflow actually starts with
specbefore tests. Consider updating for accuracy:📝 Committable suggestion
🤖 Prompt for AI Agents