From 0c4c5e4ea6e5466f43d06eee714ecbe901a711a9 Mon Sep 17 00:00:00 2001 From: Francesco Novy Date: Fri, 21 Jun 2024 14:12:05 +0200 Subject: [PATCH] docs: Update gitflow docs with caveat --- docs/gitflow.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/gitflow.md b/docs/gitflow.md index aa1927384d73..8926c614bcfc 100644 --- a/docs/gitflow.md +++ b/docs/gitflow.md @@ -12,3 +12,9 @@ We use [Gitflow](https://docs.github.com/en/get-started/quickstart/github-flow) - Never merge directly into `master` (unless we want e.g. an emergency bugfix release) ![gitflow-chart](./assets/gitflow-chart.png) + +## Important Caveats + +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.