Skip to content

Corrections in README #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
neoscie merged 1 commit into from
Jun 28, 2023
Merged

Corrections in README #15

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ The base ruleset consists of the default ruleset of the Roslyn Analyzers we incl
- We include our own [stylecop.json](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md) configuration file.

## Versioning
Given a version number MAJOR.MINOR.PATCH, an incremented number for:
Given a version number `MAJOR.MINOR.PATCH`, an incremented number for:

- MAJOR version means there are incompatible changes with the previous version,
- MINOR version means functionality and rules were added, and
- PATCH version means that the changes are all completely backwards compatible. Usually when rules were lowered in severity or disabled/removed.
- `MAJOR` version means there are incompatible changes with the previous version,
- `MINOR` version means functionality and rules were added, and
- `PATCH` version means that the changes are all completely backwards compatible. Usually when rules were lowered in severity or disabled/removed.

### What it means in practice:
- You can (and should) always update the package to the latest **PATCH** version whenever you have the chance to do it, it should never break the build.
- Updating to the latest **MINOR** version can break the build and may require minor refactorings. But you can expect to have Roslyn code fixes and/or documentation available for the changes that are needed to fix the build.
- **MAJOR** updates will break your build and may require major refactorings.
- You can (and should) always update the package to the latest `PATCH` version whenever you have the chance to do it, it should never break the build.
- Updating to the latest `MINOR` version can break the build and may require minor refactorings. But you can expect to have Roslyn code fixes and/or documentation available for the changes that are needed to fix the build.
- `MAJOR` updates will break your build and may require major refactorings.