microsoft / microsoft/OpenAPI.NET
Docs to explain why behind breaking changes
Aberta
Ninguém assumiu esta issue ainda.
type:documentation
- Linguagem predominante
- C#
- Estrelas
- 1.6k
- Forks
- 286
- Merge médio
- 6h 38min
- PRs com merge (30d)
- 35
Descrição
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.
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Comece lendo o guia de upgrade existente, que aborda o que mudou e como fazer o upgrade. Identifique as breaking changes do OpenAPI.NET 2.0 listadas nele e, em seguida, adicione uma documentação complementar explicando a justificativa por trás delas; considera-se concluído quando os clientes puderem entender por que as mudanças foram feitas.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- csharp, openapi
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 35/100