a2ui-project / a2ui-project/a2ui

Create a `specification-change` skill

Đang mở
#1,689 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
P2
Ngôn ngữ chính
TypeScript
Star
16.4k
Fork
1.3k
Merge trung bình
2 ngày 13 giờ
Pull request đã merge (30 ngày)
134

Mô tả

A skill to help with updating the specifications. It should explain:
- The different states specifications can be in e.g. draft, candidate, final etc.
- The types of changes that are allowed in each state
- How to create a new specification
- The writing style to use
- The set of files to consider e.g. both Markdown and JSON
- How to write and run the appropriate tests

Perhaps most of this is just regular documentation at `specification/docs` that is referenced by a skill. That way, it can also be discovered by humans easily.

The skill should specifically mention some things that need to be considered that are non-obvious including:
- Make sure you update the rules governing the structure of catalog documents, including the "allowed schemas" in `common-types.json` that can be referenced from component and function schemas.

This comes from @gspencergoog 's idea in https://github.com/a2ui-project/a2ui/pull/1629#discussion_r3424979613

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Look at the existing skills in the codebase to understand their structure and location. Review the specification documentation at `specification/docs` to understand the content that needs to be referenced. The skill should guide users through specification states, change types, and updating `common-types.json`. Test by creating and running the skill in the development environment.

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

Đánh giá

Công nghệ
json, markdown, typescript
Lĩnh vực
documentation, tooling
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
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
65/100

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.