Skip to content

Commit 12e64f9

Browse files
authored
Corrections in README (#15)
1 parent ab0a2bd commit 12e64f9

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,13 @@ The base ruleset consists of the default ruleset of the Roslyn Analyzers we incl
1414
- We include our own [stylecop.json](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/Configuration.md) configuration file.
1515

1616
## Versioning
17-
Given a version number MAJOR.MINOR.PATCH, an incremented number for:
17+
Given a version number `MAJOR.MINOR.PATCH`, an incremented number for:
1818

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

2323
### What it means in practice:
24-
- 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.
25-
- 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.
26-
- **MAJOR** updates will break your build and may require major refactorings.
24+
- 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.
25+
- 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.
26+
- `MAJOR` updates will break your build and may require major refactorings.

0 commit comments

Comments
 (0)