Handbook version numbering: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(2 intermediate revisions by the same user not shown) | |||
Line 9: | Line 9: | ||
And what is meant by these versions? | And what is meant by these versions? | ||
;Major version ( | ;Major version (Rewrite) | ||
:This is where the handbook has been rewritten to the point that external references are meaningless - the chapters are in a different order, or the content has been reorganised to such an extent that it's effectively a different book. | :This is where the handbook has been rewritten to the point that external references are meaningless - the chapters are in a different order, or the content has been reorganised to such an extent that it's effectively a different book. | ||
;Minor version (Revision) | ;Minor version (Revision) | ||
:This is where a substantive change to the rules has been made (even a small one) | :This is where a substantive change to the rules has been made (even a small one) e.g., changing the required diameter of a thrusting tip. | ||
:The rules themselves have changed, but the document is still basically the same book. | :The rules themselves have changed, but the document is still basically the same book. | ||
;Correction | ;Correction (Correction) | ||
:This is where the rules aren't changing - the only change that is being made is in the actual text or possibly layout of the book. It's intended for dealing with typos or formatting errors. | :This is where the rules aren't changing - the only change that is being made is in the actual text or possibly layout of the book. It's intended for dealing with typos or formatting errors. | ||
: This may include things where at the most pedantic reading a rule change is being made, but the change is being made to correct an obvious error (e.g., if the rules accidentally said that swords had to be 114 inches in diameter, rather than 1 1/4 inches) | : This may include things where at the most pedantic reading a rule change is being made, but the change is being made to correct an obvious error (e.g., if the rules accidentally said that swords had to be 114 inches in diameter, rather than 1 1/4 inches) |
Latest revision as of 03:23, 28 July 2019
The versioning in use on handbooks presented here follows a modified semantic versioning principle.
Versions are given as three numbers, separated by dots. e.g., 2.1.3.
These are [major version].[minor version].[correction version].
These should be incremented as the relevent kind of change is made, and reset to zero when a higher level change is made. So when you go up a major version, minor version and layout version should reset to zero.
And what is meant by these versions?
- Major version (Rewrite)
- This is where the handbook has been rewritten to the point that external references are meaningless - the chapters are in a different order, or the content has been reorganised to such an extent that it's effectively a different book.
- Minor version (Revision)
- This is where a substantive change to the rules has been made (even a small one) e.g., changing the required diameter of a thrusting tip.
- The rules themselves have changed, but the document is still basically the same book.
- Correction (Correction)
- This is where the rules aren't changing - the only change that is being made is in the actual text or possibly layout of the book. It's intended for dealing with typos or formatting errors.
- This may include things where at the most pedantic reading a rule change is being made, but the change is being made to correct an obvious error (e.g., if the rules accidentally said that swords had to be 114 inches in diameter, rather than 1 1/4 inches)