Skip to content

Commit 0402cae

Browse files
Update README.md
1 parent dbc611b commit 0402cae

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# wdds
2-
This repo is a convenient Storage location for Wild Disease Data Standard files.
2+
This repo is a storage location for Wild Disease Data Standard files.
33

44
## Abstract
55
Rapid and comprehensive data sharing is vital to the transparency and actionability of wildlife infectious disease surveillance and research.
@@ -16,6 +16,15 @@ The wddsWizard package contains [searchable documentation for terms](https://vir
1616

1717
Data can also be validated against the JSON schema using a validation engine (e.g. [AJV](https://ajv.js.org/guide/getting-started.html)).
1818

19+
## Versioning
20+
21+
1) All versions of WDDS will include a version number in their title (e.g. v1.0.0).
22+
- Changes including updating required fields, changing field names, adding or removing value restrictions, or other breaking changes will result in a major release bump (1.0.0 -> 2.0.0)
23+
- Non-breaking changes that impact validation - refining regex patterns, correcting or refining enum values, etc - will result in a minor release bumb (1.0.0 -> 1.1.0)
24+
- Non-breaking changes that do not impact validation - updating descriptions, adding examples, etc - will result in a patch release bumb (1.0.0 -> 1.0.1)
25+
2) When a new version of the schema is published, a new github release will be created as well as a new version of the schema on Zenodo
26+
3) `wddsWizard` and other validation libraries we may create will use the most recent version of the data standard by default.
27+
1928

2029

2130

0 commit comments

Comments
 (0)