From 0b004a8597fcf27cf259d9002d9bc30c2e2a0179 Mon Sep 17 00:00:00 2001 From: Nick Gheorghita Date: Mon, 27 Aug 2018 11:15:43 -0600 Subject: [PATCH] Add changelog instructions --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 937344d..8843960 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,11 @@ The version format for this repo is `{major}.{minor}.{patch}` for stable, and `{major}.{minor}.{patch}-{stage}.{devnum}` for unstable (`stage` can be alpha or beta). To issue the next version in line, specify which part to bump, -like `make release bump=minor` or `make release bump=devnum`. +like `make release bump=minor` or `make release bump=devnum`. This is typically done from the +master branch, except when releasing a beta (in which case the beta is released from master, +and the previous stable branch is released from said branch). To include changes made with each +release, update "docs/releases.rst" with the changes, and apply commit directly to master +before release. If you are in a beta version, `make release bump=stage` will switch to a stable.