We use Gitflow as a branching model.

• Ongoing work happens on the develop branch
• Any PRs (features, ...) are implemented as PRs against develop
• When we are ready to release, we merge develop into master, create a release there, then merge master back into develop
• Whatever is currently on master can be considered the last released state of the SDK
• Never merge directly into master (unless we want e.g. an emergency bugfix release)

While a release is pending, we may merge anything into develop, except for changes to package.json files. If we change the package.json files on develop, the gitflow PR master -> develop will have merge conflicts, because during the release the package.json files are updated on master.

Although gitflow should help us to avoid merge conflicts, as mentioned above in "Important Caveats" it can still happen that you get a merge conflict when trying to merge master into develop after a successful release.

If this happen, you can resolve this as follows:

• Close the automated PR that was created by the gitflow automation
• Create a new branch on top of master (e.g. manual-develop-sync)
• Merge develop into this branch, with a merge commit (and fix any merge conflicts that come up)
• Now create a PR against develop from your branch (e.g. manual-develop-sync)
• Merge this PR with a merge commit