Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How should we use version numbers for authorities data changes? #26

Open
adrianshort opened this issue Oct 9, 2018 · 1 comment
Open
Labels
question Further information is requested

Comments

@adrianshort
Copy link
Owner

Semantic versioning 2.0.0 says:

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

MAJOR version when you make incompatible API changes,
MINOR version when you add functionality in a backwards-compatible manner, and
PATCH version when you make backwards-compatible bug fixes.

Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.

This gem includes data in the authorities.csv file. Should changes to this file be regarded as adding functionality, requiring updating the MINOR version number, or just backwards compatible bug fixes, requiring an update to the PATCH version?

Perhaps two scenarios:

  1. A new authority is added. This is regarded as new functionality (you can now do something you couldn't do before: scrape that authority's data) so we update the MINOR version.
  2. An existing authority is modified: either the URL has changed or we've added/removed tags. This is a "bugfix" so we update the PATCH version.

Thoughts? How would this proposal tie in with keeping track of versions usefully in your Gemfile?

@adrianshort adrianshort added the question Further information is requested label Oct 9, 2018
@dhilton
Copy link

dhilton commented Oct 9, 2018

My opinion is that you're changing PATCH type information; authorities.csv could be a config file that a user downloads from the internet (I'm not suggesting you take this route) or it could query the data from some online canonical data URI (again not suggesting you do this) it just happens to be a bundled config file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants