docs: add release and contributing guidelines (#62)

Author: andreafalzetti

README.md

@@ -5,14 +5,105 @@ This is the browser extension for Gitpod. It supports Chrome (see [Chrome Web St
 
  ![Gitpodify](./docs/github-injected.png "Gitpodify")
 
-## Build
 
-### Chrome & Firefox
+## Contributing
+
+Contributions to this project are welcome!
+
+### Issues
+
+We are currently tracking all issues related to the browser extension in the [`gitpod-io/gitpod`](https://github.com/gitpod-io/gitpod) repository.
+You can use the [`component: browser-extension`](https://github.com/gitpod-io/gitpod/issues?q=is%3Aissue+is%3Aopen+extension+label%3A%22component%3A+browser-extension%22) label to search for relevant issues including feature proposals and bug reports.
+
+### Development
+
+To make changes and test them, the easiest way is using Gitpod itself. The `.gitpod.yml` configuration for this project installs Google Chrome and runs a VNC server to allow users to see the Desktop of the Docker container. When a workspace starts, Google Chrome is started with the Gitpod extension automatically built from source and pre-installed, therefore you can preview your changes in the ephemeral Chrome browser. 🤯
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](gitpod.io/#https://github.com/gitpod-io/browser-extension)
+
+#### Build
+
+The build happens automatically when you start a workspace but if you want to build explicitly, use these commands:
 
 ```
-yarn install && yarn build && yarn package
+yarn install
+yarn build
+yarn package
 ```
 
+### Testing
+
+You can test the extension without publishing to the store. Before uploading the bundle to the browser, make sure to [build](#build) the code, then follow these steps:
+
+For Chrome:
+
+1. Rename `gitpod.xpi` to `gitpod.zip`
+1. Unzip `gitpod.zip`
+1. Open Chrome
+1. Click Settings -> Extensions -> Load unpacked
+1. Select the unzipped folder
+
+For Firefox
+
+1. Open Firefox
+1. Click Preferences -> Extensions & Themes 
+1. Click on the cog icon -> Install Add-on From File -> Select the `gitpod.xpi` file
+
+For Safari (Experimental 🧪)
+
+1. Open `Gitpod/Gitpod.xcodeproj`
+1. Run the project with `cmd` + `r`. ⚠️ _Safari must have [**Allow Unsigned Extensions**](https://developer.apple.com/documentation/safariservices/safari_app_extensions/building_a_safari_app_extension) enabled._
+
+## Release
+
+We currently publish the extension for **Chrome** and **Firefox**.
+
+To release a new version, follow these steps:
+
+1. Bump up the version value inside `manifest.json`
+1. Push your changes to `master`
+1. Create a tag `vX.Y.Z`
+1. Compose a list of changes using the list of commits that were pushed since last version
+1. [Create a new release](https://github.com/gitpod-io/browser-extension/releases/new), listing changes:
+
+    ```yaml
+    ### Changes
+
+    - Change/Fix A
+    - Change/Fix B
+    - Change/Fix C
+
+    ### Credits
+
+    Thanks to @{EXTERNAL_CONTRIBUTOR_USERNAME} for helping! 🍊
+    ```
+
+1. Start a new workspace using Gitpod
+1. Download `gitpod.xpi` which is just been generated in your workspace
+
+For Firefox:
+
+1. Login to [addons.mozilla.org](https://addons.mozilla.org/) with user `[email protected]`
+1. Click on "See all versions"
+1. Click on "Upload New Version"
+1. Upload the `gitpod.xpi` file
+1. Select only "Firefox" (leave empty "Firefox for Android")
+1. Answer "No" at the question “Do you use any of the following in your extension?”
+1. Click "Continue"
+1. Click "Submit Version"
+1. Wait a few hours for the review to happen!
+
+For Chrome:
+
+1. Using your Google account, open the [`gitpod-browser-extension Google Group`](https://groups.google.com/g/gitpod-browser-extension)
+1. If you don't have access, reach out for [help in Slack](https://gitpod.slack.com/archives/C020VCB0U5A)
+1. Once you are in the Google Group, make sure to "Switch to Gitpod" in the top navbar
+1. Rename `gitpod.xpi` to `gitpod.zip`
+1. Click "Upload new package"
+1. Upload the zip file and submit
+1. Wait a few hours for the review to happen!
+
+
 ### Safari
 
 #### ⚠️ A machine running macOS and [Xcode 12+](https://developer.apple.com/xcode/) installed is required!
@@ -33,23 +124,4 @@ yarn build:safari
 
 Hit `enter` when presented with this screen.
 
-`Xcode` will open the `Gitpod.xcodeproj` automatically if it's installed.
-
-## Test
-
-[Build](#build) the extension and
-* unzip `gitpod.xpi` and load it as [“unpackaged extension” (Chrome)](https://developer.chrome.com/extensions/getstarted) or
-* load `gitpod.xpi` as [“temporary add-on” (Firefox)](https://blog.mozilla.org/addons/2015/12/23/loading-temporary-add-ons/) or
-* open `Gitpod/Gitpod.xcodeproj` and run the project with `cmd` + `r`. ⚠️ _Safari must have [**Allow Unsigned Extensions**](https://developer.apple.com/documentation/safariservices/safari_app_extensions/building_a_safari_app_extension) enabled._
-
-The extension is active until the next restart of your browser.
-
-## Publishing
-
-- **Chrome:** Users that are member of the Google group [`gitpod-browser-extension`](https://groups.google.com/g/gitpod-browser-extension) are allowed to update new versions in the [Chrome Webstore Developer Dashboard](https://chrome.google.com/webstore/devconsole/11ad35cc-5b54-416a-a789-f091e1007648).
-- **Firefox:** Login at https://addons.mozilla.org/ with user `[email protected]`.
-
-## Issues
-
-We are currently tracking all issues related to the browser extension in the [`gitpod-io/gitpod`](https://github.com/gitpod-io/gitpod) repository.
-You can use the [`component: browser-extension`](https://github.com/gitpod-io/gitpod/issues?q=is%3Aissue+is%3Aopen+extension+label%3A%22component%3A+browser-extension%22) label to search for relevant issues including feature proposals and bug reports.
+`Xcode` will open the `Gitpod.xcodeproj` automatically if it's installed.