refactor: remove OpenAPI/GraphQL bias from templates#1652
refactor: remove OpenAPI/GraphQL bias from templates#1652mnriem merged 5 commits intogithub:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates Spec Kit templates to remove REST/OpenAPI/GraphQL-centric language so the spec → plan → tasks workflow better fits non-web project types (libraries, CLIs, compilers, desktop apps, etc.).
Changes:
- Replaces “Generate API contracts”/“endpoints” wording with more general “interface contracts/interfaces” language in planning and task-generation templates.
- Updates the spec authoring template to recommend project-appropriate integration patterns (REST/GraphQL, function calls, CLI args, etc.).
- Expands the plan template’s “Project Type” examples to cover a broader set of project categories.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| templates/plan-template.md | Broadens “Project Type” examples beyond single/web/mobile. |
| templates/commands/tasks.md | Generalizes contracts/endpoints terminology to interfaces/interface contracts. |
| templates/commands/specify.md | Replaces REST-default integration guidance with project-appropriate patterns. |
| templates/commands/plan.md | Replaces API-contract generation step with interface-contract definition + skip guidance for internal-only projects. |
| pyproject.toml | Changes the package version (currently appears to be a downgrade and inconsistent with CHANGELOG). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
Comments suppressed due to low confidence (1)
templates/commands/tasks.md:32
- In this optional artifacts list,
contracts/is described as "interface definitions", but later in the same template (e.g., the mapping step) it uses "interface contracts". Please pick one term and use it consistently throughout to avoid confusing agents/users about what goes incontracts/.
- **Optional**: data-model.md (entities), contracts/ (interface contracts), research.md (decisions), quickstart.md (test scenarios)
- Note: Not all projects have all documents. Generate tasks based on what's available.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
* chore: bump version to v0.0.5 [skip ci] * refactor: update documentation for interface contracts and integration patterns * Update pyproject.toml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update templates/commands/tasks.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update templates/commands/tasks.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 participant
Fixes #1614
Summary
Removes the hardcoded OpenAPI/REST/GraphQL assumptions from templates and replaces them with project-type-appropriate language, so the spec-driven workflow works equally well for libraries, CLI tools, compilers, desktop apps, etc.
Changes
templates/commands/plan.md: Replace "Generate API contracts" step (hardcoded REST/GraphQL) with "Define interface contracts" that adapts to the project type, with examples for different project types and a skip condition for purely internal projects.templates/commands/tasks.md: Replace "endpoints" and "API" references with "interfaces" and "interface contracts" throughout.templates/commands/specify.md: Replace "RESTful APIs unless specified otherwise" default with "project-appropriate patterns" covering REST, GraphQL, function calls, CLI args, etc.templates/plan-template.md: Expand Project Type field fromsingle/web/mobileto a broader set of examples (library/cli/web-service/mobile-app/compiler/desktop-app).Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com