-
Notifications
You must be signed in to change notification settings - Fork 7.2k
docs: update references from "Supported AI Agents" to "Supported AI T… #1987
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
MUHAMMEDHAFEEZ
wants to merge
10
commits into
github:main
Choose a base branch
from
MUHAMMEDHAFEEZ:main
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
Show all changes
10 commits
Select commit
Hold shift + click to select a range
a53e076
docs: update references from "Supported AI Agents" to "Supported AI T…
MUHAMMEDHAFEEZ 2048790
docs: update references from "AI coding agent" to "AI coding tool"
MUHAMMEDHAFEEZ be701c9
feat: add compact template format to reduce token usage
MUHAMMEDHAFEEZ f4c4525
Usage:
MUHAMMEDHAFEEZ c7f382a
Delete .claude directory
MUHAMMEDHAFEEZ 6f71c10
Update src/specify_cli/__init__.py
MUHAMMEDHAFEEZ 6cd5a3d
Update docs/upgrade.md
MUHAMMEDHAFEEZ 1ddff67
Update templates/commands/compact/tasks.md
MUHAMMEDHAFEEZ 5347a8b
Update templates/commands/compact/specify.md
MUHAMMEDHAFEEZ a3fbe08
Merge branch 'main' into main
MUHAMMEDHAFEEZ 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
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
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
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,54 @@ | ||
| --- | ||
| description: Non-destructive cross-artifact consistency and quality analysis across spec.md, plan.md, and tasks.md. | ||
| scripts: | ||
| sh: scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks | ||
| ps: scripts/powershell/check-prerequisites.ps1 -Json -RequireTasks -IncludeTasks | ||
| --- | ||
|
|
||
| ## Input | ||
|
|
||
| ```text | ||
| $ARGUMENTS | ||
| ``` | ||
|
|
||
| Consider user input before proceeding (if not empty). | ||
|
|
||
| ## Constraints | ||
|
|
||
| **READ-ONLY**: Never modify files. Output structured analysis report only. | ||
| **Constitution** (`/memory/constitution.md`) is non-negotiable - conflicts are always CRITICAL. | ||
|
|
||
| ## Workflow | ||
|
|
||
| 1. Run `{SCRIPT}`, parse FEATURE_DIR. Derive SPEC, PLAN, TASKS paths. Abort if any missing. | ||
|
|
||
| 2. **Load** minimal context from each artifact: | ||
| - spec.md: requirements, success criteria, user stories, edge cases | ||
| - plan.md: architecture, data model, phases, constraints | ||
| - tasks.md: IDs, descriptions, phases, [P] markers, file paths | ||
| - constitution: principles, MUST/SHOULD statements | ||
|
|
||
| 3. **Build models**: Requirements inventory (FR-###, SC-###), user story/action inventory, task coverage mapping, constitution rule set. | ||
|
|
||
| 4. **Detection passes** (max 50 findings): | ||
| - A. **Duplication**: near-duplicate requirements | ||
| - B. **Ambiguity**: vague terms without metrics, unresolved placeholders | ||
| - C. **Underspecification**: missing outcomes, unaligned stories, undefined references | ||
| - D. **Constitution alignment**: MUST principle violations, missing mandated sections | ||
| - E. **Coverage gaps**: requirements with zero tasks, orphan tasks, unbuildable success criteria | ||
| - F. **Inconsistency**: terminology drift, entity mismatches, ordering contradictions | ||
|
|
||
| 5. **Severity**: CRITICAL (constitution violation, zero-coverage blocking req) > HIGH (conflicts, ambiguous security/perf) > MEDIUM (terminology drift, missing NFR tasks) > LOW (style, minor redundancy) | ||
|
|
||
| 6. **Report** (markdown, no file writes): | ||
|
|
||
| | ID | Category | Severity | Location(s) | Summary | Recommendation | | ||
| |----|----------|----------|-------------|---------|----------------| | ||
|
|
||
| + Coverage summary table + Constitution issues + Unmapped tasks + Metrics (total reqs, tasks, coverage%, ambiguity/duplication/critical counts) | ||
|
|
||
| 7. **Next actions**: If CRITICAL → resolve before `/speckit.implement`. If LOW/MEDIUM → may proceed with suggestions. | ||
|
|
||
| 8. **Offer remediation**: Ask user if they want concrete edit suggestions for top N issues (don't apply automatically). | ||
|
|
||
| Context: {ARGS} |
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,49 @@ | ||
| --- | ||
| description: Generate a custom checklist for the current feature - "unit tests for requirements writing". | ||
| scripts: | ||
| sh: scripts/bash/check-prerequisites.sh --json | ||
| ps: scripts/powershell/check-prerequisites.ps1 -Json | ||
| --- | ||
|
|
||
| ## Input | ||
|
|
||
| ```text | ||
| $ARGUMENTS | ||
| ``` | ||
|
|
||
| Consider user input before proceeding (if not empty). | ||
|
|
||
| ## Core Concept | ||
|
|
||
| Checklists are **unit tests for requirements** - they validate quality, clarity, and completeness of requirements, NOT implementation behavior. | ||
|
|
||
| - YES: "Are visual hierarchy requirements defined?" / "Is 'fast' quantified with metrics?" | ||
| - NO: "Verify button clicks" / "Test error handling works" | ||
|
|
||
| ## Workflow | ||
|
|
||
| 1. **Setup**: Run `{SCRIPT}`, parse FEATURE_DIR and AVAILABLE_DOCS. | ||
|
|
||
| 2. **Clarify intent**: Generate up to 3 contextual questions from user phrasing + spec signals (scope, depth, audience, risk). Skip if already clear from $ARGUMENTS. May ask 2 follow-ups if gaps remain (max 5 total). | ||
|
|
||
| 3. **Load context**: Read spec.md, plan.md (if exists), tasks.md (if exists) - only relevant portions. | ||
|
|
||
| 4. **Generate checklist**: | ||
| - Create `FEATURE_DIR/checklists/[domain].md` | ||
| - If exists: append continuing from last CHK ID. Never delete existing content. | ||
| - Group by: Completeness, Clarity, Consistency, Measurability, Coverage, Edge Cases, NFRs, Dependencies, Ambiguities | ||
| - Each item: question format about requirement quality with [dimension] tag | ||
| - Include traceability refs: `[Spec §X.Y]`, `[Gap]`, `[Ambiguity]`, `[Conflict]` | ||
| - Soft cap: 40 items, merge near-duplicates, consolidate low-impact edge cases | ||
|
|
||
| 5. **Report**: Path, item count, focus areas, whether created or appended. | ||
|
|
||
| ## Item Format | ||
|
|
||
| ``` | ||
| - [ ] CHK### Are [requirement type] defined/specified for [scenario]? [Dimension, Spec §X.Y] | ||
| ``` | ||
|
|
||
| Patterns: "Are X defined?" / "Is X quantified?" / "Are X consistent between A and B?" / "Can X be measured?" / "Does spec define X?" | ||
|
|
||
| Prohibited: "Verify", "Test", "Confirm" + implementation behavior / "Displays correctly" / "Click", "navigate", "render" |
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,52 @@ | ||
| --- | ||
| description: Identify underspecified areas in feature spec, ask up to 5 targeted clarification questions, encode answers back into spec. | ||
| handoffs: | ||
| - label: Build Technical Plan | ||
| agent: speckit.plan | ||
| prompt: Create a plan for the spec. I am building with... | ||
| scripts: | ||
| sh: scripts/bash/check-prerequisites.sh --json --paths-only | ||
| ps: scripts/powershell/check-prerequisites.ps1 -Json -PathsOnly | ||
| --- | ||
|
|
||
| ## Input | ||
|
|
||
| ```text | ||
| $ARGUMENTS | ||
| ``` | ||
|
|
||
| Consider user input before proceeding (if not empty). | ||
|
|
||
| ## Workflow | ||
|
|
||
| 1. Run `{SCRIPT}`, parse FEATURE_DIR and FEATURE_SPEC. Abort if JSON fails. | ||
|
|
||
| 2. **Scan spec** using taxonomy (mark Clear/Partial/Missing): | ||
| - Functional scope, domain/data model, UX flow, non-functional (perf/scale/security/observability), integrations, edge cases, constraints, terminology, completion signals, placeholders | ||
|
|
||
| 3. **Generate max 5 questions** (prioritized by Impact*Uncertainty): | ||
| - Must be answerable via multiple-choice (2-5 options) or short answer (<=5 words) | ||
| - Only include if answer materially impacts architecture, testing, UX, or compliance | ||
| - Balance category coverage | ||
|
|
||
| 4. **Ask one at a time**: | ||
| - Multiple-choice: show **Recommended** option with reasoning + options table. User can pick letter, say "yes"/"recommended", or custom answer | ||
| - Short-answer: show **Suggested** answer. User can accept or provide own | ||
| - Stop when: all resolved, user signals done, or 5 questions asked | ||
|
|
||
| 5. **Integrate each answer** immediately: | ||
| - Add `## Clarifications` > `### Session YYYY-MM-DD` if missing | ||
| - Append `- Q: <question> → A: <answer>` | ||
| - Update appropriate spec section (requirements, stories, data model, success criteria, edge cases) | ||
| - Replace obsolete statements, save after each integration | ||
|
|
||
| 6. **Validate**: No duplicates, <=5 questions, no lingering placeholders, consistent terminology. | ||
|
|
||
| 7. **Report**: Questions asked/answered, path to updated spec, sections touched, coverage summary, next command suggestion. | ||
|
|
||
| ## Rules | ||
|
|
||
| - Never exceed 5 questions | Present one at a time | Never reveal future questions | ||
| - If no ambiguities: report "No critical ambiguities" and suggest proceeding | ||
| - If spec missing: instruct to run `/speckit.specify` first | ||
| - Respect early termination ("done", "stop", "proceed") |
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,41 @@ | ||
| --- | ||
| description: Create or update project constitution from interactive or provided principle inputs. | ||
| handoffs: | ||
| - label: Build Specification | ||
| agent: speckit.specify | ||
| prompt: Implement the feature specification based on the updated constitution. I want to build... | ||
| --- | ||
|
|
||
| ## Input | ||
|
|
||
| ```text | ||
| $ARGUMENTS | ||
| ``` | ||
|
|
||
| Consider user input before proceeding (if not empty). | ||
|
|
||
| ## Workflow | ||
|
|
||
| 1. **Load** `.specify/memory/constitution.md`. Identify all `[PLACEHOLDER]` tokens. Respect user's desired principle count. | ||
|
|
||
| 2. **Collect values**: From user input, repo context, or inference. Version: semver (MAJOR=breaking, MINOR=additions, PATCH=clarifications). LAST_AMENDED_DATE=today if changes made. | ||
|
|
||
| 3. **Draft**: Replace all placeholders with concrete text. Each principle: name + non-negotiable rules + rationale. Governance: amendment procedure + versioning + compliance expectations. | ||
|
|
||
| 4. **Propagate**: Check alignment with plan-template.md, spec-template.md, tasks-template.md, commands/*.md. Update references if needed. | ||
|
|
||
| 5. **Sync Report**: Add HTML comment at top: version change, modified/added/removed sections, templates needing updates. | ||
|
|
||
| 6. **Validate**: No unexplained brackets, version matches report, dates ISO, principles are declarative+testable (MUST/SHOULD not vague "should"). | ||
|
|
||
| 7. **Write** to `.specify/memory/constitution.md`. | ||
|
|
||
| 8. **Report**: Version + bump rationale, files needing follow-up, suggested commit message. | ||
|
|
||
| ## Rules | ||
|
|
||
| - Use exact template heading hierarchy | ||
| - Single blank line between sections | ||
| - If partial updates: still validate and version-decide | ||
| - Missing info: insert `TODO(<FIELD>): explanation` | ||
| - Always operate on existing file, never create new template |
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.
This section was renamed to “Supported AI Tools”, but the bullets below still refer to “agent” (“Add the new agent…”, “agent's official website link”, etc.). For consistency with the new terminology, update these bullet items to use “tool” as well.