microsoft / microsoft/OpenAPI.NET
Add conceptual docs for OpenAPI
Đang mở
Chưa có ai nhận issue này.
type:documentation
type:epic
- Ngôn ngữ chính
- C#
- Star
- 1.6k
- Fork
- 286
- Merge trung bình
- 6 giờ 38 phút
- Pull request đã merge (30 ngày)
- 35
Mô tả
- Include getting started docs & tutorials for OpenAPI Writers lib
- Include getting started docs & tutorials for Hidi tool and add scenario-based tutorials eg using Hidi with API manifest from Graph Explorer
Hướng dẫn đóng góp
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
Bắt đầu bằng cách xác định các điểm bắt đầu của tài liệu hiện có cho thư viện OpenAPI Writers và công cụ Hidi. Xác định phạm vi nội dung hướng dẫn bắt đầu và hướng dẫn cho cả hai, bao gồm một kịch bản sử dụng Hidi với một API manifest từ Graph Explorer. Công việc được xem là hoàn tất khi tài liệu khái niệm và các hướng dẫn được yêu cầu đã được thêm cho cả hai công 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ệ
- csharp, openapi
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- 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
- 42/100