docs: enhance contributing document with releasing section (#19)

* docs: enhance contributing document with releasing section

* fix: fix typo bath to patch

Author: NachoVazquez

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,6 +5,7 @@ Please check if your PR fulfills the following requirements:
 - [ ] The commit message follows our guidelines: CONTRIBUTING.md#commit
 - [ ] Tests for the changes have been added (for bug fixes / features)
 - [ ] Docs have been added / updated (for bug fixes / features)
+- [ ] The latest artifacts are committed (run `yarn build`)
 
 ## PR Type
 

CONTRIBUTING.md

@@ -13,7 +13,7 @@ yarn
 Build the typescript and package it for distribution
 
 ```bash
-yarn build && yarn package
+yarn build
 ```
 
 Run the tests :heavy_check_mark:
@@ -22,6 +22,62 @@ Run the tests :heavy_check_mark:
 yarn test
 ```
 
+Make sure you include the latest distribution built in your PR commits
+
+```bash
+yarn build && git add .
+```
+
+## Releasing a new version (for core contributors only)
+
+Always release from main
+
+```bash
+git fetch origin && git switch -C main origin/main
+```
+
+Generate the changelog, commit and tag of the release.
+
+```bash
+yarn release
+```
+
+Push the generated commit into `origin/main`
+
+```bash
+git push origin main
+```
+
+Push the generated version tag into `origin/main`.
+
+```bash
+git push --follow-tags origin main
+```
+
+This Github action follows the [recommended release workflow](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md#recommendations)
+
+### Releasing minor and patch versions
+
+> NOTE: This operation may need multiple attempts. Always verify that the sha of the latest major version tag matches the latest commit in the main branch
+
+Match the major version release tag with the newly create release tag.
+
+```bash
+git tag -fa v3 -m "update v3 tag to v3.x.y"
+```
+
+Push the updated major version to force the release into the Github Marketplace
+
+```bash
+git push origin v1 --force
+```
+
+### Releasing a major version
+
+Go to create a new release in Github a follow the instructions [there](https://github.com/ngworker/angular-versions-action/releases/new).
+
+Use the major version format for the release. For example if the current major version tag is `v3` the new release version must be `v4`.
+
 ## <a name="rules"></a> Coding Rules
 
 To ensure consistency throughout the source code, keep these rules in mind as you are working:
@@ -33,7 +89,7 @@ To ensure consistency throughout the source code, keep these rules in mind as yo
 
 We have very precise rules over how our git commit messages can be formatted. This leads to **more
 readable messages** that are easy to follow when looking through the **project history**. But also,
-we use the git commit messages to **generate the Lumberjack changelog**.
+we use the git commit messages to **generate the angular-versions-action changelog**.
 
 ### Commit Message Format
 

README.md

@@ -1,7 +1,5 @@
 # GitHub Action - Match Angular Versions
 
-> DISCLAIMER: THIS ACTION IS HIGHLY EXPERIMENTAL.
-
 This GitHub Action (written in JavaScript) modifies the root `package.json` of a project and replaces the version of all **Angular** related dependencies for given base version.
 
 [![ngworker](https://img.shields.io/badge/ngworker-%40-red)](https://github.com/ngworker/)