Skip to content

Commit

Permalink
Escapes all pipes to eliminate tables in Jekyll
Browse files Browse the repository at this point in the history
For DEFINITION.md
  • Loading branch information
quantum9Innovation committed May 2, 2021
1 parent 14bcb46 commit 0fa59b7
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions versioning/DEFINITION.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,19 +53,19 @@ Note on language used:

(5) Version `1.0.0` defines the public API. The way in which the version number is incremented after this release is dependent on this public API and how it changes. After a version `1.0.0` has been published, the following rules apply:

(5.1) Patch version `c` (`a.b.C` | `a` > 0) MUST be incremented to reflect small bugfixes and other changes that must not deprecate any valid dependents of this package. A *small* bugfix is defined as a backwards-compatible non-breaking API change that fixes a *contained* bug. A bug is *contained* if it affects only one part of the codebase and will not cause any valid dependent code to receive an error.
(5.1) Patch version `c` (`a.b.C` \| `a` > 0) MUST be incremented to reflect small bugfixes and other changes that must not deprecate any valid dependents of this package. A *small* bugfix is defined as a backwards-compatible non-breaking API change that fixes a *contained* bug. A bug is *contained* if it affects only one part of the codebase and will not cause any valid dependent code to receive an error.

(6.1) Patch version `c` (`a.b.C` | `a` = 0) MUST be incremented to reflect small bugfixes and other changes that must not deprecate any valid dependents of this package.
(6.1) Patch version `c` (`a.b.C` \| `a` = 0) MUST be incremented to reflect small bugfixes and other changes that must not deprecate any valid dependents of this package.

(5.2) Minor version `b` (`a.B.c` | `a` > 0) MUST be incremented to reflect minor enhancements, critical bugfixes, or minor deprecations. A minor enhancement is a backwards-compatible enhancement that only modifies existing code or is simply a symbolic enhancement (i.e. one that makes it simpler to execute code that could have already been executed another way in the previous version of the package). A critical bugfix is one that fixes an *uncontained* bug or a non-backwards-compatible or breaking API change applied to a *contained* bug. An *uncontained* bug is a bug that is not *contained*—in other words, a bug that affects multiple parts of the codebase, can spread to other parts of the codebase, or will cause valid dependent code to receive an error. Similarly, a minor deprecation is one that is *contained*. Here, a *contained* deprecation MUST be confined to a certain part of the codebase meaning that no valid dependent code will need to be restructured—only have some parts removed or modified slightly.
(5.2) Minor version `b` (`a.B.c` \| `a` > 0) MUST be incremented to reflect minor enhancements, critical bugfixes, or minor deprecations. A minor enhancement is a backwards-compatible enhancement that only modifies existing code or is simply a symbolic enhancement (i.e. one that makes it simpler to execute code that could have already been executed another way in the previous version of the package). A critical bugfix is one that fixes an *uncontained* bug or a non-backwards-compatible or breaking API change applied to a *contained* bug. An *uncontained* bug is a bug that is not *contained*—in other words, a bug that affects multiple parts of the codebase, can spread to other parts of the codebase, or will cause valid dependent code to receive an error. Similarly, a minor deprecation is one that is *contained*. Here, a *contained* deprecation MUST be confined to a certain part of the codebase meaning that no valid dependent code will need to be restructured—only have some parts removed or modified slightly.

(6.2) For minor version `b` (`a.B.c` | `a` = 0), `b` MUST be incremented to reflect any enhancements or deprecations and critical bugfixes.
(6.2) For minor version `b` (`a.B.c` \| `a` = 0), `b` MUST be incremented to reflect any enhancements or deprecations and critical bugfixes.

(5.3) Major version `a` (`A.b.c` | `a` > 0) MUST be incremented every time a large deprecation or major feature release occurs. A large deprecation is one that is not a minor deprecation and is not *contained*. A major feature release is one that is not a minor enhancement—anything that is non-backwards-compatible and is not a symbolic enhancement.
(5.3) Major version `a` (`A.b.c` \| `a` > 0) MUST be incremented every time a large deprecation or major feature release occurs. A large deprecation is one that is not a minor deprecation and is not *contained*. A major feature release is one that is not a minor enhancement—anything that is non-backwards-compatible and is not a symbolic enhancement.

(6.3) A pre-release version MAY be denoted by appending a hyphen and a series of dot separated identifiers immediately following the patch version. Identifiers MUST comprise only ASCII alphanumerics and hyphens [0-9 : A-Z : a-z]. Identifiers MUST NOT be empty if no `d` version is specified. Numeric identifiers MUST NOT include leading zeros. Pre-release versions have a lower precedence than the associated normal version. A pre-release version indicates that the version is unstable and might not satisfy the intended compatibility requirements as denoted by its associated normal version. Examples: 1.0.0-alpha, 1.0.0-alpha.1, 1.0.0-0.3.7, 1.0.0-x.7.z.92, 1.0.0-x-y-z.–.

(5.4) However, the optional update version `d` can also be used and appended to the version `a.b.c` as `a.b.c.D`. `d` MUST NOT be zero at any time. Update version `d` (`a.b.c.D` | `a` > 0) MUST imply a possibly unstable or developing version of `a.b.c`. It SHOULD be incremented anytime such a change is made. These versions MAY be yanked as soon as the next PATCH, MINOR, or MAJOR update is released. `d` is not required and MUST NOT be specified on any stable version `a.b.c`.
(5.4) However, the optional update version `d` can also be used and appended to the version `a.b.c` as `a.b.c.D`. `d` MUST NOT be zero at any time. Update version `d` (`a.b.c.D` \| `a` > 0) MUST imply a possibly unstable or developing version of `a.b.c`. It SHOULD be incremented anytime such a change is made. These versions MAY be yanked as soon as the next PATCH, MINOR, or MAJOR update is released. `d` is not required and MUST NOT be specified on any stable version `a.b.c`.

(6.4) When `a` = 0, it MAY be preferable to merge this into `c` and increment the PATCH version instead since it is understood that the package is unstable.

Expand Down

0 comments on commit 0fa59b7

Please sign in to comment.