microsoft / microsoft/OpenAPI.NET
Docs to explain why behind breaking changes
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- C#
- Estrellas
- 1.6k
- Forks
- 286
- Merge medio
- 6 h 38 min
- PR fusionados (30 d)
- 35
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Empieza leyendo la guía de actualización existente, que explica qué ha cambiado y cómo realizar la actualización. Identifica los breaking changes de OpenAPI.NET 2.0 que enumera y, después, añade documentación complementaria que explique la razón de esos cambios; el trabajo estará terminado cuando los clientes puedan entender por qué se realizaron.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- csharp, openapi
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100