Target readers 👩🏽💻 🌍
Releases and changelog
What we want to accomplish through releases and changelog (share the state of the project with stake holders, allow dev to have ) Folowing Keep a changelog structure
Semantic versioning on Half Earth
We do our own flavour of Semantic Versioning, in order to fulfill the specificities of a data intensive user facing project. In short, updates on version number will increase depending on the type of change that has been done to the codebase.
This should be the structure of the version number: major.minor.patch
Find below the types of changes that fit in each category:
Major
- New Features (like in Jira epics)
- New data layers
- Higher scale data layers
Minor
- Data layers updates
- Metadata updates (in case anything needs to be deployed from the platform)
- Js API upgrades
- Chore implementation for internal use
- Design iterations on existing features
Patch
- Bug fixes
- Typos