Merge pull request #128 from odilia-app/add_release_checklist

Add release checklist

README.md

@@ -25,25 +25,6 @@ We use the asynchronous zbus API, so to use atspi, you will need to run an async
 [async-std](https://crates.io/crates/async-std).
 The `async-io` and `tokio` features are exposed and will be passed through to zbus.
 
-## Contributing
-
-We love people who add functionality, find bugs, or improve code quality!
-You can clone the repository and make modifications just by `git clone`-ing the repository like so:
-
-```bash
-git clone https://github.com/odilia-app/atspi
-cd atspi
-cargo build
-```
-
-If you have permissions to publish to crate to [crates.io](https://crates.io/),
-then please make sure to tag it like so, pushing it to get, and *then* publishing to crates.io:
-
-```bash
-git tag -a vMAJ.MIN.PATCH -m "New feature in tag"
-git push origin --tags
-```
-
 ## License
 
 The `atspi` library is licensed as [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html) or [MIT](https://mit-license.org/).

RELEASE-CHECKLIST.md

@@ -0,0 +1,21 @@
+# Release Checklist
+
+If you're attempting to create a release for `atspi` or any of its subcrates, please make sure to follow the steps below.
+Throughout the document, `MAJ`, `MIN` and `PATCH` should be replaced with the major, minor and patch version of the library respectively.
+
+* Make a branch named `vMAJ.MIN.PATCH-release`
+* Make any needed changes to internal and external version numbers
+* Make a PR to `https://github.com/odilia-app/atspi/` with this branch
+* Make sure all tests pass
+* Attempt to do a `cargo publish` with the `--dry-run` flag to test for potential issues.
+* Tag latest commit with `git tag vMAJ.MIN.PATCH -m "Update message"`
+* Push tags `git push --tags`
+* Publish to `crates.io`: `cargo publish` for each subcrate first, in this order:
+	1. `atspi-common`
+	2. `atspi-proxies`
+	3. `atspi-connections`
+	4. `atspi`
+* Merge the changes of the branch back into `main`
+
+Creating a separate branch for each release allows us to backport emergency fixes if required for a patch release.
+