Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

[Feature]: Add artifact, optional, and handoffs to the command manifest schema

Ouverte
  • Quelque chose ne va pas ?
#4,209 5 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 2 jours

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
64/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Active
Stack technique
python
Domaine
cli, tooling

Piste de recherche

Commencez par src/specify_cli/extensions/init.py et src/specify_cli/presets/init.py, puis examinez relative_extension_path_violation dans src/specify_cli/_utils.py ainsi que l’intégration Forge. Comparez le command frontmatter existant dans templates/commands/plan.md avec les modèles de manifeste et déterminez le normalized handoff mapping. Le travail est terminé lorsque la validation, la précédence, le comportement du schéma rétrocompatible, le Forge stripping et la documentation sont couverts par la vérification de l’implémentation.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

enhancement feature-assess feature-go
Problem Statement

ExtensionCommand and preset command entries model fields such as type, name, file, description, and strategy, but do not expose artifact (the repo-relative output path a command produces), optional (whether a flow can skip it), or handoffs (declarative follow-on commands).

handoffs currently lives in command frontmatter and is stripped by several markdown integrations, including Forge. This forces downstream consumers such as wizard UIs, flow runners, and pipeline visualizers to re-parse markdown frontmatter and prevents these semantics from being consistently available through the command manifest model.

Proposed Solution

Add optional artifact, optional, and handoffs fields to extension and preset command manifest entries:

commands:
  - name: speckit.plan
    file: commands/speckit.plan.md
    description: "..."
    artifact: specs/{feature}/plan.md
    optional: false
    handoffs:
      - to: speckit.tasks
        when: "plan.status == 'done'"
        message: "Ready to break plan into tasks"

Parse command frontmatter during manifest loading and merge its handoffs into the command entry when the manifest does not declare them. If both sources provide handoffs, the manifest value takes precedence.

Keep handoffs in the in-memory model, while continuing to strip it on the Forge export path. Define how the existing frontmatter shape (label, agent, prompt, send) maps to or coexists with the manifest shape (to, when, message). In other words, add handoffs to the normalized in-memory command model and JSON output. Accept an explicit manifest declaration as an optional override, but derive it from command frontmatter when absent. Authors should not need to duplicate handoffs in both files.

Alternatives Considered
  • Leave handoffs frontmatter-only and require consumers to parse it. Rejected because downstream consumers would duplicate parsing.
  • Derive artifact from the command file. Rejected because a command may produce multiple artifacts or none.
  • Bump schema_version without a compatibility strategy. Current validators use exact-version matching, so a bump would reject existing manifests. Prefer an additive change under the current version unless compatibility policy is deliberately changed.
Component

Specify CLI (initialization, commands)

AI Agent (if applicable)

Not applicable

Use Cases
  1. A wizard renders a Spec-Driven Development pipeline graph by walking handoffs edges without opening markdown files.
  2. A flow runner shows a skip action for commands with optional: true and refuses to auto-skip mandatory commands.
  3. An audit joins a command's artifact path to files in the repository.
Acceptance Criteria
  • Extension and preset command schemas accept optional artifact (string), optional (bool, default false), and handoffs (list of {to, when?, message?}).
  • The manifest loader merges command-file frontmatter handoffs when the manifest does not declare its own value.
  • Manifest-declared handoffs takes precedence over frontmatter.
  • Forge export continues to strip handoffs from exported frontmatter.
  • artifact is validated as repo-relative; handoffs[].to resolves to a known command; optional is validated as a boolean.
  • The schema-version decision is recorded, with backward-compatible behavior for existing manifests.
  • Valid and malformed manifest entries, frontmatter merge precedence, and Forge stripping are covered by the implementation verification.
  • The manifest schema and handoffs semantics are documented in the relevant existing documentation.
Additional Context

Impacts preset info --json / extension info --json, which are tracked separately.

Relevant implementation locations include src/specify_cli/extensions/__init__.py, src/specify_cli/presets/__init__.py, src/specify_cli/_utils.py::relative_extension_path_violation, and src/specify_cli/integrations/forge/__init__.py. Existing command frontmatter examples include templates/commands/plan.md.

Langage dominant
Python
Étoiles
138k
Forks
12.4k
Merge moyen
2 j 11 h
PR mergées (30 j)
163

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de github/spec-kit

Toutes les issues de github/spec-kit

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.