OpenAPITools / OpenAPITools/openapi-diff

Markdown output does not specify whether the change is backward-compatible or not

未关闭
#766 1 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

Breaking/Non-Breaking classification Render capabilities
主要语言
Java
星标
1.1k
派生
190
PR 合并指标
30 天内没有已合并 PR

描述

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从项目 README 中的 Markdown 输出示例开始,将其与 issue 中提到的 HTML 输出和默认 CLI 输出进行比较。从这里追踪 Markdown 报告的生成过程;当 Markdown 输出能够与其他格式一致地说明每项更改是否向后兼容时,即视为完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
java
领域
api
Issue 类型
缺陷
难度
3/5
预计耗时
1-2 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
48/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。