Document breaking changes - Githubissues

medic / cht-sync

Data synchronization between CouchDB and PostgreSQL for the purpose of analytics.

GNU General Public License v3.0

4 stars 5 forks source link

Document breaking changes #180

Closed dianabarsan closed 2 weeks ago

dianabarsan commented 2 weeks ago

CHT-Sync should be versioned and respect semver guidelines:

bugfixes in patches
features in minors
breaking changes in majors

The criteria for a change to be breaking in cht-sync would be:

changing data structures significantly enough that a resync is required
data structure migrations that require iterating over large data sets for updates
removal of existent features
behavioral updates of existing features
updates in configuration that are not backwards compatible