Skip to content
This repository was archived by the owner on Feb 12, 2025. It is now read-only.

Commit aee9465

Browse files
committedFeb 1, 2019
Add some details about release process. [skip-ci]
1 parent 598ef85 commit aee9465

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed
 

‎CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ this same document.
1919
- `misc/`: for anything else (like adding docs, READMEs, etc.).
2020
- We open a *pull request* when we think the branch should be merged. **Becareful: when opening
2121
the pull request, select `develop` as base branch!**
22+
- Do not forget to update the CHANGELOG.md **before** opening a pull request.
2223
- We review the *pull request*. We don’t set a fixed number of reviewers, but don’t forget the
2324
golden rule: the more people review, the better.
2425
- If your change impacts no path from the CI (for instance, you just added a new tool or fixed a
@@ -32,10 +33,29 @@ this same document.
3233
to your changes.
3334
- Do the same thing in [appveyor.yml] for the `LIB_VERSION` key.
3435
- [We appologize for not having automated that yet.](#117)
36+
- Do not forget to bump the version, if needed, **before** opening a pull request
3537
- We *tag* stable releases on `master` with [SemVer].
3638
- We *tag* instable releases on `develop` with the special `-rc` suffix to support *release
3739
candidates*.
3840

41+
## Release process
42+
- Development : fixes, features are done on specific branches on developers' fork,
43+
- Pull requests: submitted to LedgerHQ/develop with updated of CHANGELOG.md,
44+
- Merge into `LedgerHQ/develop`: triggers CI builds and deploys under `x.y.z-rc-commitHash`,
45+
- Merge into `LedgerHQ/master`: once a version is confirmed to be stable by at least by one of our clients
46+
(Vault or Live), we bump project’s version, for this we jhave a special pull request. Once merged in
47+
`LedgerHQ/master` and tagged as a stable release `x.y.z`, a build and a deployment are triggered.
48+
To sum up, tags point to stable releases that are in production. **These versions should be used by any application
49+
client of libcore**
50+
- Patches: only applied on previously affected releases that has been in production, to apply a patch to a version `x.y.z`,
51+
we create a branch from master at `x.y.z` tag, push all fixes to it, once stable (confirmed by client)
52+
we tag a new patched stable release (e.g. `x.y.(z+1)`). Then this branch is merged to `LedgerHQ/develop`.
53+
Each 3/4 weeks we clean upstream from unused branches.
54+
55+
<p align="center">
56+
<img src="/ressources/patch.png" width="550"/>
57+
</p>
58+
3959
## About coin integration
4060

4161
We might accept coin integration at some day but currently, **we do not accept pull-requests that add

‎ressources/patch.png

202 KB
Loading

0 commit comments

Comments
 (0)
This repository has been archived.