Skip to content

Commit 2fc8a26

Browse files
author
delphidabbler
committed
Updated CollectionFormat.md
Updated version info file info
1 parent 5f2674d commit 2fc8a26

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

csdb/v4.16/docs/CollectionFormat.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -317,9 +317,11 @@ The `LICENSE-INFO` file is not referenced by, and does not reference, any of the
317317

318318
## Version Information File
319319

320-
There is a plain UTF-8 text file named `VERSION` that contains the version number of the database. The current major version is v2.
320+
There is a plain UTF-8 text file named `VERSION` that contains the version number of the database in the form vX.X.X. where X represents a non-negative integer. The file is required and must be non-empty.
321321

322-
Databases before v2.0.0 did not have a `VERSION` file<sup>3</sup>.
322+
Version numbers must be incremented according to to the principles of [semantic versioning](https://semver.org/).
323+
324+
The current major version is v2. Databases before v2.0.0 did not have a `VERSION` file<sup>3</sup>.
323325

324326
The `VERSION` file is not referenced by, and does not reference, any of the other files in the collection.
325327

@@ -329,6 +331,6 @@ The `VERSION` file is not referenced by, and does not reference, any of the othe
329331

330332
<sup>**2**</sup> Here is an example of how the <em>Credits</em> and <em>Credits_URL</em> key values in the individual category `.ini` files are used. If <em>Credits</em>="`See [example]`" and <em>Credits_URL</em>="`http://example.com</em>`" and the <em>Extra</em>key is empty or missing then the extra text generated will be `See <a href="example.com">example 1</a>`.
331333

332-
<sup>**3**</sup> Version tracking was not done before v2.0.0. However it is safe to assume, using semantic versioning, that the current format is the second major release. This is because all previous database versions were backwards compatible and therefore all belonged to the same major version, which, logically, must have been v1. The fact that this version of the database breaks that backward compatibility means the major version must be bumped.
334+
<sup>**3**</sup> Version tracking was not done before v2.0.0. However it is safe to assume, using [semantic versioning](https://semver.org/), that the current format is the second major release. This is because all previous database versions were backwards compatible and therefore all belonged to the same major version, which, logically, must have been v1. The fact that this version of the database breaks that backward compatibility means the major version must be bumped.
333335

334336
<sup>**4**</sup> If "contributors" is specified as part of the *CopyrightHolder* key value in `LICENSE-INFO` then the `CONTRIBUTORS` file *must* contain a list of all the contributors.

0 commit comments

Comments
 (0)