dotnet / docs

This repository contains .NET Documentation.
https://learn.microsoft.com/dotnet
Creative Commons Attribution 4.0 International
4.23k stars 5.88k forks source link

Semantic Versioning #23343

Open ghost opened 3 years ago

ghost commented 3 years ago

Request for better semantic versioning page

I like this guide but to an idiot (like me who is starting to learn C# as a grade 8 student,) I don't know what an incompatible API change is and would like some examples. Another thing that doesn't make sense is "when you add functionality in a backwards-compatible manner", does that mean every time I make a change where you have to update the app I change the Major version?

All I know about Semantic Versioning is that a BIG update is a new Major version like v1.0.0. An added feature (like new items to buy in-game or new bad guys to defeat) is a Minor version like v0.1.0. And a patch/bug fix, is like a patch/bug fix, fixing a small bug where you can't see an enemy for example. But my problem is knowing when to make a Major version and what "when you add functionality in a backwards-compatible manner" means.

Console.WriteLine("Thank you for your time!");

Edit by @BillWagner to add the document details block.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

BillWagner commented 3 years ago

closing and reopening to apply new labels.

BillWagner commented 3 years ago

I've added this to our backlog.