microsoft / microsoft/OpenAPI.NET
Docs to explain why behind breaking changes
Nessuno ha ancora preso questa issue.
- Lingua principale
- C#
- Stelle
- 1.6k
- Fork
- 286
- Merge medio
- 6h 38m
- PR unite (30g)
- 35
Descrizione
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.
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia leggendo la guida all'aggiornamento esistente, che illustra cosa è cambiato e come eseguire l'aggiornamento. Identifica i breaking changes di OpenAPI.NET 2.0 elencati e aggiungi quindi una documentazione complementare che ne spieghi la motivazione; il lavoro è completato quando i clienti possono capire perché sono state apportate le modifiche.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- csharp, openapi
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 35/100