Contribute docs

contribute/README.md

@@ -0,0 +1,31 @@
+# Contribute to ce-dev
+
+## Release instructions
+
+1. [Create a pull request](https://github.com/codeenigma/ce-dev/compare) to the `1.x` branch.
+
+2. Once it is accepted, `git pull` your local `1.x` branch so it is up to date.
+
+3. Working on `1.x` directly, edit [`package.json`](https://github.com/codeenigma/ce-dev/blob/1.x/package.json) in the repository root.
+
+4. Bump the version on line 4 to the number you want. If you are at version 1.2.3 you would bump it to 1.2.4 for a minor release or 1.3.0 for a major release. If you are introducing breaking change that will not be backward compatible you should use 2.0.0.
+
+5. Commit your change.
+
+6. Tag it with git, e.g. `git tag 1.2.4`
+
+7. Push the branch back up with tags, e.g. `git push origin 1.x --tags`
+
+[GitHub Actions](https://github.com/codeenigma/ce-dev/actions) should now take care of the release for you.
+
+## Rolling back a release
+
+If you need to pull a release, follow these instructions:
+
+1. Locally in your terminal on the `1.x` branch update the tags, e.g. `git pull --tags`
+
+2. Delete the tag locally, e.g. `git tag -d 1.2.4`
+
+3. Push the deletion up too, e.g. `git push --delete origin 1.2.4`
+
+The deletion of the tag should also delete all trace of the release.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "ce-dev",
   "description": "Local Stack wrapper tool",
-  "version": "1.1.9",
+  "version": "1.1.10",
   "author": " @pm98zz-c",
   "bin": {
     "ce-dev": "./bin/run"