Docs to explain why behind breaking changes
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- csharp, openapi
- Domain
- documentation
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.
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.
- Dominant language
- C#
- Stars
- 1.6k
- Forks
- 286
- Avg merge
- 6h 38m
- Merged PRs (30d)
- 35
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.
More from microsoft/OpenAPI.NET
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
microsoft/OpenAPI.NET#2798 ·
-
microsoft/OpenAPI.NET#3056 · 1 comment · 1 reaction · 2 assignees ·
-
type:breaking-change
Difficulty 4/5 3-5 days Newbie friendliness 52/100
microsoft/OpenAPI.NET#3014 · 2 comments ·
-
help wanted
Difficulty 5/5 Over a week Newbie friendliness 35/100
microsoft/OpenAPI.NET#2989 · 3 comments ·
-
help wanted type:feature
Difficulty 3/5 1-2 days Newbie friendliness 55/100
microsoft/OpenAPI.NET#2967 · 18 comments · 1 reaction ·
All issues in microsoft/OpenAPI.NET
Similar issues
-
Status: Waiting triage Type: Bug
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
nanoframework/Home#1857 ·
-
kind/bug kind/regression
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
unoplatform/uno.toolkit.ui#1646 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
nightscout/nocturne#1379 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
elastic/esql-dotnet#47 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100