Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

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

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#4,738 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 2 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
88/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với docs/reference/core.md và docs/guides/monorepo.md, xác định các mô tả về SPECIFY_FEATURE_DIRECTORY, bảng biến môi trường và ghi chú về hai trục. Cập nhật cả hai trang để phân biệt thư mục gốc của dự án với vị trí của tài liệu tính năng, giữ nguyên cách phân giải đường dẫn tương đối và nêu rõ rằng các đường dẫn tuyệt đối hoặc bên ngoài được chọn một cách rõ ràng đều được phép; xác minh rằng các thay đổi chỉ liên quan đến tài liệu.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
138k
Fork
12.4k
Merge trung bình
2 ngày 11 giờ
Pull request đã merge (30 ngày)
163

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của github/spec-kit

Tất cả issue của github/spec-kit

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.