-
Notifications
You must be signed in to change notification settings - Fork 46
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
Versioning, changelog, notices of updates to the data format #11
Comments
Great suggestions! We are planning to implement both a CHANGLOG.md and a |
Could we re-open this? A change log was just one part of my request. So, for an example of why versioning would be helpful: Right now ~500 files are published according to a previous schema (see #17). Because of a lag in getting those files regenerated, the data files posted aren't all generated in a consistent format. I don't want to have to guess which schema is in use for which file. |
Tagging #25 here as an example of why we need to talk more about this. The changelog was posted only after files with the new format were published. |
A new top-level element |
A few related questions:
CHANGELOG.md
file at the root of this repo would be a great place to list changes to the data format. Here's an example of a CHANGELOG from one of my projects. Now that the documentation is in Markdown we could just look at the diffs, but a CHANGELOG would be clearer and more explicit.Why to do versioning:
How to do versioning:
A date would work well here as a version number. e.g. The
2016-04-27
version would represent the bill status data format as it was on April 27, 2016. The date would be incremented only when the data format actually changes. This gets around deep questions of whether a change should increment a major version number, minor version number, etc etc.A simple integer (version
201
) would also work, as would semantic versioning (1.2.3
).The text was updated successfully, but these errors were encountered: