microsoft / microsoft/OpenAPI.NET

Docs to explain why behind breaking changes

Ouverte
#2,426 0 commentaires 4 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

type:documentation
Langage dominant
C#
Étoiles
1.6k
Forks
286
Merge moyen
6 h 38 min
PR mergées (30 j)
35

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par lire le guide de mise à niveau existant, qui décrit ce qui a changé et comment effectuer la mise à niveau. Identifiez les breaking changes d’OpenAPI.NET 2.0 qu’il répertorie, puis ajoutez une documentation complémentaire expliquant la raison de ces changements ; le travail est considéré comme terminé lorsque les clients peuvent comprendre pourquoi ces changements ont été effectués.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
csharp, openapi
Domaine
documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.