Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update contributing guidelines #10223

Merged
merged 16 commits into from
Oct 1, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review
Co-authored-by: Amaury <1293565+amaurym@users.noreply.github.com>
  • Loading branch information
robert-zaremba and amaury1093 authored Sep 30, 2021
commit be26d0d39a27b6b2ddba077af50c96d83acd8beb
2 changes: 1 addition & 1 deletion CODING-GUIDELINES.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing Guidelines
# Coding Guidelines
robert-zaremba marked this conversation as resolved.
Show resolved Hide resolved

This document is an extension to [CONTRIBUTING](./CONTRIBUTING.md) and provides more details about the coding guidelines and requirements.

Expand Down
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Contributing to this repo can mean many things such as participating in
discussion or proposing code changes. To ensure a smooth workflow for all
contributors, the general procedure for contributing has been established:

1. Start by browsing [new issue](https://github.com/cosmos/cosmos-sdk/issues) and [discussions](https://github.com/cosmos/cosmos-sdk/discussions). If you are looking for something interesting or if you have something in your mind, there is a chance it was has been discussed.
1. Start by browsing [new issues](https://github.com/cosmos/cosmos-sdk/issues) and [discussions](https://github.com/cosmos/cosmos-sdk/discussions). If you are looking for something interesting or if you have something in your mind, there is a chance it was has been discussed.
- Looking for a good place to start contributing? How about checking out some [good first issues](https://github.com/cosmos/cosmos-sdk/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)?
2. Determine whether a GitHub issue or discussion is more appropriate for your needs:
1. If want to propose something new that requires specification or an additional design, or you would like to change a process, start with a [new discussion](https://github.com/cosmos/cosmos-sdk/discussions/new). With discussions, we can better handle the design process using discussion threads. A discussion usually leads to one or more issues.
Expand Down Expand Up @@ -200,9 +200,9 @@ If needed, we backport a commit from `master` to a release branch (excluding con

### Major Release Procedure
robert-zaremba marked this conversation as resolved.
Show resolved Hide resolved

A _major release_ is an increment of the first number (eg: `v1.2` → `v2.0.0`) or the __point number_ (eg: `v1.1 → v1.2.0`, also called _point release_).
A _major release_ is an increment of the first number (eg: `v1.2` → `v2.0.0`) or the _point number_ (eg: `v1.1 → v1.2.0`, also called _point release_).

TL;DR before making a new _major_ release we do beta and release candidate releases. For example, for release 1.0.0:
Before making a new _major_ release we do beta and release candidate releases. For example, for release 1.0.0:
```
v1.0.0-beta1 → v1.0.0-beta2 → ... → v1.0.0-rc1 → v1.0.0-rc2 → ... → v1.0.0
```
Expand Down Expand Up @@ -235,7 +235,7 @@ Following _semver_ philosophy, point releases after `v1.0`:

Before `v1.0`, point release can break both point API and consensus.

### Path Release Procedure
### Patch Release Procedure

A _patch release_ is an increment of the patch number (eg: `v1.2.0` → `v1.2.1`).

Expand Down Expand Up @@ -367,6 +367,6 @@ well as for PRs made as part of a release process:
* Code reviewers should have more senior engineering capability
* 1/2 approval is required from the **primary repo maintainers** in `CODEOWNERS`

**Note**: For any major release series denoted as a "Stable Release" (e.g. v0.39 "Launchpad"), a separate release
**Note**: For any major release series denoted as a "Stable Release" (e.g. v0.42 "Stargate"), a separate release
committee is often established. Stable Releases, and their corresponding release committees are documented
separately in [STABLE_RELEASES.md](./STABLE_RELEASES.md)*