From ee049aee87f8d4a96705a9a03b90fa4a4ce89be7 Mon Sep 17 00:00:00 2001 From: Dan Finlay Date: Thu, 9 May 2019 12:35:24 -0700 Subject: [PATCH] Document hotfix protocol --- docs/publishing.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/publishing.md b/docs/publishing.md index 392e20955..8d50e6869 100644 --- a/docs/publishing.md +++ b/docs/publishing.md @@ -42,3 +42,16 @@ With each pull request, the @MetaMaskBot will comment with a build of that new p 4. Publish to [Opera store](https://addons.opera.com/en/extensions/details/metamask/). 5. Post on [Github releases](https://github.com/MetaMask/metamask-extension/releases) page. 6. Run the `npm run announce` script, and post that announcement in our public places. + +## Hotfix Differences + +Our `develop` branch is usually not yet fully tested for quality assurance, and so should be treated as if it is in an unstable state. + +For this reason, when an urgent change is needed in production, its pull request should: + +- Describe it as a hotfix. +- Use a hotfix tag. +- Should be proposed against the `master` branch. + +The version and changelog bump should then be made off the `master` branch, and then merged to `develop` to bring the two branches back into sync. Further time can be saved by incorporating the version/changelog bump into the PR against `master`, since we rely on @MetaMaskBot to run tests before merging. +