From 8479f3e5cf9feba0ec8231fd5468e37b722b34e0 Mon Sep 17 00:00:00 2001 From: dbr Date: Wed, 5 Oct 2022 12:54:13 +1030 Subject: [PATCH] Proposed branching/release process Closes #665 --- docs/development-process.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 docs/development-process.md diff --git a/docs/development-process.md b/docs/development-process.md new file mode 100644 index 0000000..c368627 --- /dev/null +++ b/docs/development-process.md @@ -0,0 +1,32 @@ +# imgui-rs development process + +As summarised in [issue #665](https://github.com/imgui-rs/imgui-rs/issues/665) + +In summary: + +1. There is a `main` branch +2. For each semver compatible release there is a stable branch (e.g `0.9-stable`) +3. Each patch release becomes a tagged commit on this stable branch (e.g `v0.9.5` would come from a tagged commit on the `0.9-stable` branch) + +## General process + +Day to day development + +1. Work on `main` branch +2. General PR's are submitted against the `main` branch + +When it is time to make a new release, we create a `x.y-stable` branch (e.g `0.9-stable`) from `main` + +1. Ensure `CHANGELOG` is up to date +1. Bump `version` in the various `Cargo.toml` +2. A stable branch is created, e.g `git switch -c 0.9-stable` and pushed to Github + +All further PR's are still done to `main` + +1. If they are applicable to previous release (e.g bugfixes or non-breaking changes), they are cherry-picked back to the applicable `stable` branch(es) + +## When to bump versions in Cargo.toml + +Only before publishing to crates.io. + +This makes users able use [patch.crates-io] without hand-editing versions throughout their dependency tree (typically impossible without forking/editing transitive dependencies, even if there are no breaking code changes otherwise).