Add a tiny end-to-end example to README/docs
- Ngôn ngữ chính
- Python
- Star
- 137k
- Fork
- 12.3k
- Merge trung bình
- 2 ngày 12 giờ
- Pull request đã merge (30 ngày)
- 159
Mô tả
I was looking through Spec Kit and the tagline “Define what to build before building it — with any AI coding agent” makes the goal clear, but I had a little trouble forming a mental model of the actual workflow from the README alone.
It would help newcomers to include a very small example near the Get Started section: a short spec file or PRD fragment, the command/template used to process it, and what the next artifact looks like when handed to an agent like Copilot. Even a contrived example like “add a /health endpoint” would make the boundaries clearer.
If a fuller example already lives in docs or an examples directory, a direct link from the README would still be useful. The main benefit is reducing the blank-page problem for people trying to map spec-driven development onto their own repo.
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu từ phần Get Started của README và kiểm tra xem trong tài liệu hoặc thư mục examples đã có ví dụ đầy đủ hơn hay chưa. Thêm một ví dụ end-to-end nhỏ bao quát một đoạn spec hoặc PRD, command hoặc template được sử dụng và artifact tạo ra cho một AI coding agent, hoặc liên kết đến một ví dụ hiện có; công việc được xem là hoàn tất khi người mới có thể làm theo workflow mà không gặp vấn đề blank-page.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 72/100