Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

docs: clarify that feature directories may be outside the project root

Offen Anfängerfreundlich
  • Stimmt etwas nicht?
#4,738 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 2 Tagen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
88/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Bereich
documentation

Rechercherichtung

Beginne mit docs/reference/core.md und docs/guides/monorepo.md und suche die Beschreibungen von SPECIFY_FEATURE_DIRECTORY, die Tabelle der Umgebungsvariablen und den Hinweis zu den zwei Achsen. Aktualisiere beide Seiten, um die Projektwurzel vom Speicherort der Feature-Dokumente zu unterscheiden, die Auflösung relativer Pfade beizubehalten und ausdrücklich festzuhalten, dass explizit ausgewählte absolute oder externe Pfade zulässig sind; überprüfe, dass die Änderungen ausschließlich die Dokumentation betreffen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

triage-nice-to-have

Problem

docs/reference/core.md describes SPECIFY_FEATURE_DIRECTORY as selecting a feature directory “within” the resolved project (environment-variable table and two-axes note). docs/guides/monorepo.md likewise says the selected feature is “within” the project. This implies a containment rule that is not intended or enforced.

Feature directories hold documentation artifacts such as spec.md and plan.md and may intentionally be outside the project root. The project root identifies the Spec Kit project and its command/configuration context; choosing an external feature directory does not relocate or select executable skills, scripts, or extensions.

Requested clarification

  • Update both pages to distinguish the project root from the feature-document location.
  • Preserve the current explanation that relative feature paths resolve against the selected project root, while making clear that an absolute path (or a relative path resolving outside the root) may select an external feature directory.
  • Clarify that the default feature path is under specs/, but explicitly selected feature paths are not restricted to the project root.

This is documentation-only: do not add path containment or change runtime behavior.

Vorherrschende Sprache
Python
Sterne
138k
Forks
12.4k
Ø Merge
2 T. 11 Std.
Gemergte PRs (30 T.)
163

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus github/spec-kit

Alle Issues in github/spec-kit

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.