Skip to content

Commit

Permalink
Document dev/master branch model more, fix #160
Browse files Browse the repository at this point in the history
  • Loading branch information
arildm committed Nov 30, 2023
1 parent adec9f5 commit 0d9b44f
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 0d9b44f

Please sign in to comment.