elias/imgui-rs
1
0
Fork 0
mirror of https://github.com/eliasstepanik/imgui-rs.git synced 2026-01-11 21:48:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #672 from dbr/devprocess

Browse Source 
Proposed branching/release process
This commit is contained in:
dbr/Ben 2022-11-22 16:47:14 +10:30 committed by GitHub
commit 1aa68fb017
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
docs/development-process.md Normal file
View File

@ -0,0 +1,35 @@
# 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
2. Bump `version` in the various `Cargo.toml`
3. A stable branch is created, e.g `git switch -c 0.9-stable` and pushed to Github
4. Create annotated tag `v0.9.0` and push to github
5. Create Release for this version on Github
6. Update and close any relevant tickets
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).