Add complete example/docs on adding traits and specifications

Đang mở
  • Có gì không ổn?
#30 1 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu với tài liệu định hướng API chính và quyết định về định dạng được theo dõi trong issue #946. Thêm ví dụ YAML dành riêng cho host với các tham chiếu trait giữa các package, các ví dụ cơ bản về việc tạo bằng CLI và sử dụng Python, cùng các cảnh báo về thông lệ tốt; được xem là hoàn tất khi tất cả các mục trong phạm vi được liệt kê đều đã được tài liệu hóa mà không thêm nội dung về CI, cách sử dụng chuyên sâu hoặc C++.

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

Mô tả

documentation task

What

Properly document the process of adding custom traits + specifications to a Host, so we have good examples of the ideas, process and resulting YAML, including cross-package references (eg. back to MediaCreation)

ACs

  • Example of adding host-specific specifications following on from a link to the main API docs.
    • Pointers to API orientation docs
    • Worked YAML authoring example with cross-package trait references
    • Basic CLI generation
    • Basic usage example (python)
    • Calls out best practices and "dont do this" in appropriate sections.
    • Format TBD in https://github.com/OpenAssetIO/OpenAssetIO/issues/946

Out of scope

  • CI/build system integration
  • In-depth usage examples
  • C++
Ngôn ngữ chính
Python
Star
7
Fork
7
Merge trung bình
1 giờ 7 phút
Pull request đã merge (30 ngày)
1

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

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 OpenAssetIO/OpenAssetIO-TraitGen

Tất cả issue của OpenAssetIO/OpenAssetIO-TraitGen

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.