From 28e6cb3f79abb6a357b5b2c2eeb4fe4e02a96ea0 Mon Sep 17 00:00:00 2001 From: Juan Cruz Viotti Date: Thu, 26 May 2016 16:13:50 -0400 Subject: [PATCH] Create docs/MAINTAINERS.md (#441) This document will evolve as a guide for maintainers to perform all sorts of common tasks. Signed-off-by: Juan Cruz Viotti --- docs/MAINTAINERS.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 docs/MAINTAINERS.md diff --git a/docs/MAINTAINERS.md b/docs/MAINTAINERS.md new file mode 100644 index 00000000..488ed0e8 --- /dev/null +++ b/docs/MAINTAINERS.md @@ -0,0 +1,39 @@ +Maintaining Etcher +================== + +This document is meant to serve as a guide for maintainers to perform common tasks. + +Preparing a new version +----------------------- + +- Bump the version number in the `package.json`'s `version` property. + +- Bump the version number in the `package.json`'s `builder.win.version` property. + +- Add a new entry to `CHANGELOG.md` describing what has been added, changed, or removed. Please use the imperative mode and capitalize the first letter of each item. + +- Link the `CHANGELOG.md` entry to the GitHub page displaying the diffs between the previous and the current version. + +```markdown +https://github.com/resin-io/etcher/compare/... +``` + +- Re-take `screenshot.png` so it displays the latest version in the bottom right corner. +- Commit the changes with the version number as the commit title, including the `v` prefix, to `master`. For example: + +```sh +git commit -m "v1.0.0" # not 1.0.0 +``` + +- Create an annotated tag for the new version. The commit title should equal the annotated tag name. For example: + +```sh +git tag -a v1.0.0 -m "v1.0.0" +``` + +- Push the commit and the annotated tag. + +```sh +git push +git push --tags +```