microsoft / microsoft/OpenAPI.NET
Docs to explain why behind breaking changes
Open
Nobody has claimed this yet.
type:documentation
- Dominant language
- C#
- Stars
- 1.6k
- Forks
- 286
- Avg merge
- 6h 38m
- Merged PRs (30d)
- 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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the existing upgrade guide, which covers what changed and how to upgrade. Identify the OpenAPI.NET 2.0 breaking changes it lists, then add companion documentation explaining the rationale behind them; done means customers can understand why the changes were made.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100