OpenDevicePartnership / OpenDevicePartnership/OpenDevicePartnership.github.io
Dynamic Repository Diagrams
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Rust
- Star
- 1
- Fork
- 10
- Merge trung bình
- 5 ngày 22 giờ
- Pull request đã merge (30 ngày)
- 1
Mô tả
The Projects landing page has 3 main links for P (Patina), EC, and ES (EC Services) which bring up a page with What, Why, Who, and a repository diagram.
This task covers improvements for those diagrams:
- Create an engine that auto-generates the diagram each time the user opens the page instead of relying on a user updated jpg. Maybe pull topics from each repo for determining how to use the URLs?
- Add text to the auto-generated diagram to explain what it is and how to read it. The text needs to be geared to a new engineer browsing the web site.
- Create an action in this repo that creates a bug if any repository is found that does not provide the necessary hooks for the diagram engine.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Kiểm tra trang đích Projects và các liên kết của trang này tới Patina, EC và EC Services, sau đó truy vết cách các sơ đồ repository hiện tại được cung cấp. Xác định engine sơ đồ, nội dung giải thích dành cho người mới và việc xác thực repository cần thiết; hoàn thành khi các sơ đồ được tạo lúc truy cập trang và một action tự động báo cáo những repository bị thiếu các hook bắt buộc.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- github-actions, rust
- Lĩnh vực
- documentation, tooling
- Loại issue
- Tính năng
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100