Skip to content

Commit cfe07f4

Browse files
authored
docs: Update gitflow docs with caveat (#12602)
We forgot to document this.
1 parent 250b6d3 commit cfe07f4

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/gitflow.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,9 @@ We use [Gitflow](https://docs.github.com/en/get-started/quickstart/github-flow)
1212
- Never merge directly into `master` (unless we want e.g. an emergency bugfix release)
1313

1414
![gitflow-chart](./assets/gitflow-chart.png)
15+
16+
## Important Caveats
17+
18+
While a release is pending, we may merge anything into develop, **except for changes to package.json files**. If we
19+
change the package.json files on develop, the gitflow PR master -> develop will have merge conflicts, because during the
20+
release the package.json files are updated on master.

0 commit comments

Comments
 (0)