Our work process when changing or removing a public API from the Matomo platform #8126
Labels
c: Website matomo.org
For issues related to our matomo.org website.
Milestone
In this issue we describe our process when we want to change or remove a public API. The goal is to put this knowledge in a guide on developer.piwik.org so it is easy to spread this knowledge to all team members including new ones in the future.
Our Backwards Compatibility Promise
All popular software platforms have a process to ensure Backward Compatibility (BC) is kept between
Minor
andPatch
releases (see Semantic Versioning 2.0.0). when BC is kept, it means users can be confident to upgrade to a newer version (Minor or Patch release) that their platform will still work (including any installed third party plugins.). For example Symfony have a very advanced BC guide: Our Backwards Compatibility Promise .Process to keep BC, and deprecate APIs
Here are the notes how our current process work:
Given:
Then:
Minor
orPatch
release@deprecated
tag in the API, event name, etc.Major
version (eg. Piwik 3.0.0) then we are will remove all@deprecated
code and therefore break BC.The text was updated successfully, but these errors were encountered: