chore: update release procedure (#915)

* chore: update release procedure

* Update CONTRIBUTING.md

Co-authored-by: Adam Wozniak <29418299+adamewozniak@users.noreply.github.com>

fix: md super linter

CONTRIBUTING.md

@@ -21,22 +21,32 @@ contributing has been established:
    discussion on that issue.
 3. If you would like to contribute:
    1. If the issue is a proposal, ensure that the proposal has been discussed
-   and accepted.
+      and accepted.
    2. Ensure that nobody else has already begun working on this issue. If they
-   have, make sure to contact them to potentially collaborate.
+      have, make sure to contact them to potentially collaborate.
    3. If nobody has been assigned for the issue and you would like to work on it,
-   make a comment on the issue to inform the community of your intentions to
-   begin work.
+      make a comment on the issue to inform the community of your intentions to
+      begin work.
    4. Follow standard GitHub best practices, i.e. fork the repo, branch from the
-   HEAD of `main`, make commits, and submit a PR to `main`
+      HEAD of `main`, make commits, and submit a PR to `main`
       - For core developers working within the repo, to ensure a clear ownership
-      of branches, branches must be named with the convention `{moniker}/{issue#}-branch-name`.
+        of branches, branches must be named with the convention `{moniker}/{issue#}-branch-name`.
    5. Be sure to submit the PR in `Draft` mode. Submit your PR early, even if
       it's incomplete as this indicates to the community you're working on
       something and allows them to provide comments early in the development
       process.
    6. When the code is complete it can be marked `Ready for Review` and follow
-   the PR readiness checklist.
+      the PR readiness checklist.
+
+## Coding Guidelines
+
+We follow the Cosmos SDK [Coding Guidelines](https://github.com/cosmos/cosmos-sdk/blob/main/CODING_GUIDELINES.md). Specifically:
+
+- API & Design SHOULD be proposed and reviewed before the main implementaion.
+- Minimize code duplication
+- Define [Acceptance tests](https://github.com/cosmos/cosmos-sdk/blob/main/CODING_GUIDELINES.md#acceptance-tests) or while implementing new features.
+  - Prefer use of acceptance test framework, like [gocuke](https://github.com/regen-network/gocuke/)
+  - For unit tests or integration tests use [go mock](https://github.com/golang/mock) for creating mocks. Generate mock interface implementations using `go generate`.
 
 ## Architecture Decision Records (ADR)
 
@@ -52,7 +62,7 @@ are in agreement before any party begins coding the proposed implementation.
 If you would like to see examples of how these are written, please refer to the
 current [ADRs](https://github.com/umee-network/umee/tree/main/docs/architecture).
 
-## Branching Model and Release
+## Branching Model
 
 The Umee network repo adheres to the [trunk based development branching](https://trunkbaseddevelopment.com/)
 model and utilizes [semantic versioning](https://semver.org/).
@@ -68,13 +78,18 @@ branch.
 ### PR & Merge Procedure
 
 - Ensure the PR branch is rebased on `main`.
+- Ensure you provided unit tests and integration tests.
 - Run `make test-unit test-e2e` to ensure that all tests pass.
 - Merge the PR!
 
-### Release Procedure
+## Release procedure
+
+We follow semver:
 
-<!-- TODO -->
+- major version update (eg 2.x.x -> 3.0.0) has API breaking changes or signals major feature update
+- minor version update (eg 2.1.x -> 2.2.0) has no API nor state machine breaking changes. It can provide new functionality or bug fixes.
+- patch version update (eg 2.1.0 -> 2.1.1) has no API nor state machine breaking changes nor new features. It only contains hot fixes.
 
-### Point Release Procedure
+### Major Release Procedure
 
-<!-- TODO -->
+All major changes related to major version update are first released for testnet. We use `-betaX` (eg `2.0.0-beta1`, `2.0.0-beta2` ...) releases for testnet. Once the code is stabilized we create a release candidate (eg `2.0.0-rc1`). If no issues are found the latest release candidate become the major release.

README.md

@@ -1,5 +1,6 @@
 <!-- markdownlint-disable MD041 -->
 <!-- markdownlint-disable MD013 -->
+
 ![Logo!](assets/umee-logo.png)
 
 [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://img.shields.io/badge/repo%20status-WIP-yellow.svg?style=flat-square)](https://www.repostatus.org/#wip)
@@ -11,7 +12,7 @@
 [![GitHub Super-Linter](https://img.shields.io/github/workflow/status/umee-network/umee/Lint?style=flat-square&label=Lint)](https://github.com/marketplace/actions/super-linter)
 
 > A Golang implementation of the Umee network, a decentralized universal capital
-facility in the Cosmos ecosystem.
+> facility in the Cosmos ecosystem.
 
 Umee is a Universal Capital Facility that can collateralize assets on one blockchain
 towards borrowing assets on another blockchain. The platform specializes in
@@ -22,19 +23,24 @@ Umee will allow a multitude of decentralized debt products.
 
 ## Table of Contents
 
-- [Compatibility Matrix](#compatibility-matrix)
+- [Releases](#releases)
 - [Active Networks](#active-networks)
   - [Public](#public)
   - [Private](#private)
 - [Install](#install)
+- [Contributing](CONTRIBUTING.md)
+
+## Releases
+
+See [Release procedure](CONTRIBUTING.md#release-procedure) for more information about the release model.
 
-## Compatibility Matrix
+### Release Compatibility Matrix
 
 | Version | Mainnet | Experimental | SDK Version | IBC Version | Peggo Version | Price Feeder Version |
-|:-------:|:-------:|:------------:|:-----------:|:-----------:|:-------------:|:--------------------:|
-|  v0.8.x |    ✗    |      ✓       |   v0.45.x   |    v2.0.x   |     v0.2.x    |        v0.1.x        |
-|  v1.x.x |    ✓    |      ✗       |   v0.45.x   |    v2.0.x   |     v0.2.x    |         N/A          |
-|  v2.x.x |    ✗    |      ✓       |   v0.45.x   |    v2.2.x   |     v0.2.x    |        v0.2.x        |
+| :-----: | :-----: | :----------: | :---------: | :---------: | :-----------: | :------------------: |
+| v0.8.x  |    ✗    |      ✓       |   v0.45.x   |   v2.0.x    |    v0.2.x     |        v0.1.x        |
+| v1.x.x  |    ✓    |      ✗       |   v0.45.x   |   v2.0.x    |    v0.2.x     |         N/A          |
+| v2.x.x  |    ✗    |      ✓       |   v0.45.x   |   v2.2.x    |    v0.2.x     |        v0.2.x        |
 
 ## Active Networks