OpenAPITools / OpenAPITools/openapi-diff
Markdown output does not specify whether the change is backward-compatible or not
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Java
- Sterne
- 1.1k
- Forks
- 190
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Markdown-Ausgabebeispiel in der README des Projekts und vergleiche es mit der im Issue erwähnten HTML- und standardmäßigen CLI-Ausgabe. Verfolge von dort aus die Generierung des Markdown-Reports; abgeschlossen ist die Aufgabe, wenn die Markdown-Ausgabe für jede Änderung konsistent mit den anderen Formaten angibt, ob sie abwärtskompatibel ist.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- api
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 48/100