OpenAPITools / OpenAPITools/openapi-diff
Markdown output does not specify whether the change is backward-compatible or not
Đang mở
Chưa có ai nhận issue này.
Breaking/Non-Breaking classification
Render capabilities
- Ngôn ngữ chính
- Java
- Star
- 1.1k
- Fork
- 190
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
From testing the tools and looking at the example Markdown output in the project README, it seems like this output doesn't specify whether a change is backward compatible or not, unlike HTML or the default CLI output.
https://github.com/OpenAPITools/openapi-diff?tab=readme-ov-file#markdown-1
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 với ví dụ về đầu ra Markdown trong README của dự án và so sánh ví dụ đó với đầu ra HTML và đầu ra CLI mặc định được đề cập trong issue. Từ đó, lần theo quá trình tạo báo cáo Markdown; hoàn thành khi đầu ra Markdown chỉ rõ mỗi thay đổi có tương thích ngược hay không, nhất quán với các định dạng khá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ệ
- java
- Lĩnh vực
- api
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 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
- 48/100