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

Add versioning information to repo documentation #13

Open
CEKrause opened this issue May 10, 2021 · 1 comment
Open

Add versioning information to repo documentation #13

CEKrause opened this issue May 10, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@CEKrause
Copy link
Collaborator

The following decisions on versioning were made by project members. We need to add this to the repo documentation somewhere:

  • WB polygons and csvs to be named by etc
  • Versioning
    • Semantic versioning – major, minor and patch
    • Docker will be updated for all updates (m, m, p)
    • Patch – backwards compatible (e.g. add a new column, new data but the existing data doesn’t change, minor debugging)
    • Minor – incremental breaking changes (e.g. restructuring folders, deleting data, modifying schema)
    • Major – considerable updates we want to promote – changes + comms (e.g. any time we majorly change the polygons, if there’s a chance we can change analysis outputs).
  • Single branch in DEA WB github page tagged with releases
@CEKrause CEKrause added documentation Improvements or additions to documentation enhancement New feature or request labels May 10, 2021
@MatthewJA
Copy link
Contributor

Note that the current version is currently stored in __version__.py; could probably update this to use setuptools_scm and automate some versioning.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants