Skip to content

Instantly share code, notes, and snippets.

@Stephen-Gates

Stephen-Gates/data-package-version.md

Last active September 26, 2017 16:50
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save Stephen-Gates/5d2326d22821eb2b80b06d440de0576e to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save Stephen-Gates/5d2326d22821eb2b80b06d440de0576e to your computer and use it in GitHub Desktop.
Download ZIP
Data Package Version
Raw
data-package-version.md

Data Package Version

The Data Package version format follows the Semantic Versioning specification format: MAJOR.MINOR.PATCH

Semantic Versioning helps developers manage dependencies between software packages. The version numbers, and the way they change, convey meaning about the underlying code and what has been modified from one version to the next.

In Data Packages this concept is applied to data.

The version numbers, and the way they change, convey meaning how the data package has been modified from one version to the next.

Given a Data Package version number MAJOR.MINOR.PATCH, increment the:

MAJOR version when you make incompatible changes, e.g.

  • Change the data structure table schema
  • Change field or data package names or data package identifiers
  • Add, remove or re-order fields

MINOR version when you add data in a backwards-compatible manner, e.g.

  • Add new data to existing data resource
  • Add a new data resource

PATCH version when you make backwards-compatible fixes, e.g.

  • corrections to existing data
  • changes to metadata

Scenarios

  • You are developing your data though public consultation.before releasing to production. Start your initial data release at 0.1.0
  • You release your datato production for the first time. Use version 1.0.0
  • You append last months data to an existing production release. Increment the MINOR version number
@henrykironde
Copy link

henrykironde commented Sep 26, 2017

@Stephen-Gates, Thanks for the updates, I totally agree with you on the URL changes after discussing the same with @zhangcandrew. We should ignore the change in the URL.

About the notifications, I am not getting any notifications from gist, but I get all the notifications from the git issues

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment