littleredbutton / bigbluebutton-api-php

Unofficial (but better) PHP API for @BigBlueButton
GNU Lesser General Public License v3.0
25 stars 12 forks source link

Introduce policy for BC breaks and feature changes #122

Open FelixJacobi opened 2 years ago

FelixJacobi commented 2 years ago

I would like to introduce a formal policy for BC breaks to make the library more reliable for consumers. I would propose:

To consider what is meant with BC, we could use Our Backward Compatibility Promise (Symfony Docs) as a guideline to lean on. The proposal for release cycle is inspired from the one Symfony, which is one of the most predictable and transparent one: The Release Process (Symfony Docs)

FelixJacobi commented 2 years ago

I already started git branching of minor versions since 4.0. This allows to use that to organize the process without many efforts. You should always be able to merge upwards without much pain. Mostly PRs can just target master acting as the development branch. Only when moving to new major version, PRs explicitly introducing BC breaks or removing features and so being for the new major version must point to a different branch.