mirrors/semver
0
0
Fork 0
mirror of https://github.com/semver/semver.git synced 2025-08-22 22:08:33 +00:00
Code

Merge pull request #623 from adamralph/patch-1

Browse Source 
switch to plural first person pronoun
This commit is contained in:
Alexandr Tovmach 2021-07-26 10:20:37 +03:00 committed by GitHub
commit fe647be722
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
semver.md
View File

@ -31,7 +31,7 @@ specified too loosely, you will inevitably be bitten by version promiscuity
Dependency hell is where you are when version lock and/or version promiscuity Dependency hell is where you are when version lock and/or version promiscuity
prevent you from easily and safely moving your project forward. prevent you from easily and safely moving your project forward.
As a solution to this problem, I propose a simple set of rules and As a solution to this problem, we propose a simple set of rules and
requirements that dictate how version numbers are assigned and incremented. requirements that dictate how version numbers are assigned and incremented.
These rules are based on but not necessarily limited to pre-existing These rules are based on but not necessarily limited to pre-existing
widespread common practices in use in both closed and open-source software. widespread common practices in use in both closed and open-source software.
@ -44,7 +44,7 @@ affecting the API increment the patch version, backwards compatible API
additions/changes increment the minor version, and backwards incompatible API additions/changes increment the minor version, and backwards incompatible API
changes increment the major version. changes increment the major version.
I call this system "Semantic Versioning." Under this scheme, version numbers We call this system "Semantic Versioning." Under this scheme, version numbers
and the way they change convey meaning about the underlying code and what has and the way they change convey meaning about the underlying code and what has
been modified from one version to the next. been modified from one version to the next.
@ -298,7 +298,7 @@ Software that explicitly depends on the same dependencies as your package
should have their own dependency specifications and the author will notice any should have their own dependency specifications and the author will notice any
conflicts. Determining whether the change is a patch level or minor level conflicts. Determining whether the change is a patch level or minor level
modification depends on whether you updated your dependencies in order to fix modification depends on whether you updated your dependencies in order to fix
a bug or introduce new functionality. I would usually expect additional code a bug or introduce new functionality. We would usually expect additional code
for the latter instance, in which case it's obviously a minor level increment. for the latter instance, in which case it's obviously a minor level increment.
### What if I inadvertently alter the public API in a way that is not compliant with the version number change (i.e. the code incorrectly introduces a major breaking change in a patch release)? ### What if I inadvertently alter the public API in a way that is not compliant with the version number change (i.e. the code incorrectly introduces a major breaking change in a patch release)?