From 0d9b44fa2f8fa3d930fec27298c9c1641490d8b4 Mon Sep 17 00:00:00 2001 From: Arild Matsson Date: Thu, 30 Nov 2023 10:13:36 +0100 Subject: [PATCH] Document dev/master branch model more, fix #160 --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 141935999..b3b92811d 100644 --- a/README.md +++ b/README.md @@ -106,10 +106,16 @@ One way to set the environment variables automatically is to use [direnv](https: # Branches, releases and versions -Development is done on the `dev`-branch. When doing a release: +Development is done on the `dev` branch. These changes are not necessarily yet stable and well-tested. + +Once tested, they can be merged to the `master` branch in a _release_. + +When doing a release: - Update version in `package.json` to the next version - Add relevent changes to `CHANGELOG.md` - Check that the user manual and development documentation is up to date - Merge `dev` to `master` (using `--no-ff`) - Tag the merge commit with the new version (prefixed with `v`, see the other tag names) + +As an external developer, when forking this respository, you may choose to pull from `dev` and/or `master`, depending on your needs for latest versus stable changes. \ No newline at end of file