microsoft / microsoft/OpenAPI.NET
Docs to explain why behind breaking changes
Đang mở
Chưa có ai nhận issue này.
type:documentation
- 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ả
Customer request:
The OpenAPI.NET 2.0 GA will bring a lot of breaking changes and customers need to understand the "why" behind them.
Ask:
Author documentation to explain the why. We currently have an upgrade guide which show the "what" and "how" to upgrade.
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 đọc hướng dẫn nâng cấp hiện có, trong đó trình bày những gì đã thay đổi và cách nâng cấp. Xác định các breaking changes của OpenAPI.NET 2.0 được liệt kê trong đó, sau đó thêm tài liệu đi kèm giải thích lý do đằng sau các thay đổi này; công việc được xem là hoàn tất khi khách hàng có thể hiểu tại sao các thay đổi được thực hiện.
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
- 35/100