forked from cosmos/cosmos-sdk
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add meeting list and working groups to contributing doc (cosmo…
…s#10315) ## Description We were requested to add more details about the meetings and how we work. --- ### Author Checklist *All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.* I have... - [ ] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [ ] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#pr-targeting)) - [ ] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/master/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/master/CONTRIBUTING.md#testing) - [ ] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [ ] reviewed "Files changed" and left comments if necessary - [ ] confirmed all CI checks have passed ### Reviewers Checklist *All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.* I have... - [ ] confirmed the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] confirmed `!` in the type prefix if API or client breaking change - [ ] confirmed all author checklist items have been addressed - [ ] reviewed state machine logic - [ ] reviewed API design and naming - [ ] reviewed documentation is accurate - [ ] reviewed tests and test coverage - [ ] manually tested (if applicable)
- Loading branch information
1 parent
40a92a2
commit 27bae80
Showing
2 changed files
with
102 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| # Contributing | ||
|
|
||
| - [Contributing](#contributing) | ||
| - [Dev Calls](#dev-calls) | ||
| - [Architecture Decision Records (ADR)](#architecture-decision-records-adr) | ||
| - [Development Procedure](#development-procedure) | ||
| - [Testing](#testing) | ||
|
|
@@ -12,8 +13,6 @@ | |
| - [Protobuf](#protobuf) | ||
| - [Branching Model and Release](#branching-model-and-release) | ||
| - [PR Targeting](#pr-targeting) | ||
| - [Major Release Procedure](#major-release-procedure) | ||
| - [Patch Release Procedure](#patch-release-procedure) | ||
| - [Code Owner Membership](#code-owner-membership) | ||
| - [Concept & Feature Approval Process](#concept--feature-approval-process) | ||
|
|
||
|
|
@@ -44,6 +43,23 @@ not required to an open issue to submit a PR, but be aware that for more complex | |
| problems/features, if a PR is opened before an adequate design discussion has | ||
| taken place in a GitHub issue, that PR runs a high likelihood of being rejected. | ||
|
|
||
| ## Teams Dev Calls | ||
|
|
||
| The Cosmos SDK has many stakeholders contributing and shaping the project. Regen Network Development leads the Cosmos SDK R&D, and welcomes long-term contributors and additional maintainers from other projects. We use self-organizing principles to coordinate and collaborate across organizations in structured "Working Groups" that focus on specific problem domains or architectural components of the Cosmos SDK. | ||
|
|
||
| The developers are organized in working groups which are listed on a ["Working Groups & Arch Process" Github Issue](https://github.com/cosmos/cosmos-sdk/issues/9058) (pinned at the top of the [issues list](https://github.com/cosmos/cosmos-sdk/issues)). | ||
|
|
||
| The important development announcements are shared on [Discord](https://discord.com/invite/cosmosnetwork) in the \#dev-announcements channel. | ||
|
|
||
| To synchronize we have few major meetings: | ||
| + Architecture calls: bi-weekly on Fridays at 14:00 UTC (alternating with the grooming meeting below). | ||
| + Grooming / Planning: bi-weekly on Fridays at 14:00 UTC (alternating with the architecture meeting above). | ||
| + Cosmos Community SDK Development Call on the last Wednesday of every month at 17:00 UTC. | ||
| + Cosmos Roadmap Prioritization every 4 weeks on Tuesday at 15:00 UTC (limited participation). | ||
|
|
||
| If you would like to join one of those calls, then please contact us on [Discord](https://discord.com/invite/cosmosnetwork) or reach out directly to Cory Levinson from Regen Network ([email protected]). | ||
|
|
||
|
|
||
| ## Architecture Decision Records (ADR) | ||
|
|
||
| When proposing an architecture decision for the Cosmos SDK, please start by opening an [issue](https://github.com/cosmos/cosmos-sdk/issues/new/choose) or a [discussion](https://github.com/cosmos/cosmos-sdk/discussions/new) with a summary of the proposal. Once the proposal has been discussed and there is rough alignment on a high-level approach to the design, the [ADR creation process](https://github.com/cosmos/cosmos-sdk/blob/master/docs/architecture/PROCESS.md) can begin. We are following this process to ensure all involved parties 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/cosmos/cosmos-sdk/tree/master/docs/architecture). | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,84 @@ | ||
| <!-- | ||
| parent: | ||
| order: false | ||
| --> | ||
|
|
||
| <div align="center"> | ||
| <h1> Cosmos SDK </h1> | ||
| </div> | ||
|
|
||
|  | ||
|
|
||
| <div align="center"> | ||
| <a href="https://github.com/cosmos/cosmos-sdk/releases/latest"> | ||
| <img alt="Version" src="https://img.shields.io/github/tag/cosmos/cosmos-sdk.svg" /> | ||
| </a> | ||
| <a href="https://github.com/cosmos/cosmos-sdk/blob/master/LICENSE"> | ||
| <img alt="License: Apache-2.0" src="https://img.shields.io/github/license/cosmos/cosmos-sdk.svg" /> | ||
| </a> | ||
| <a href="https://pkg.go.dev/github.com/cosmos/cosmos-sdk?tab=doc"> | ||
| <img alt="GoDoc" src="https://godoc.org/github.com/cosmos/cosmos-sdk?status.svg" /> | ||
| </a> | ||
| <a href="https://goreportcard.com/report/github.com/cosmos/cosmos-sdk"> | ||
| <img alt="Go report card" src="https://goreportcard.com/badge/github.com/cosmos/cosmos-sdk" /> | ||
| </a> | ||
| <a href="https://codecov.io/gh/cosmos/cosmos-sdk"> | ||
| <img alt="Code Coverage" src="https://codecov.io/gh/cosmos/cosmos-sdk/branch/master/graph/badge.svg" /> | ||
| </a> | ||
| </div> | ||
| <div align="center"> | ||
| <a href="https://github.com/cosmos/cosmos-sdk"> | ||
| <img alt="Lines Of Code" src="https://tokei.rs/b1/github/cosmos/cosmos-sdk" /> | ||
| </a> | ||
| <a href="https://discord.gg/AzefAFd"> | ||
| <img alt="Discord" src="https://img.shields.io/discord/669268347736686612.svg" /> | ||
| </a> | ||
| <a href="https://sourcegraph.com/github.com/cosmos/cosmos-sdk?badge"> | ||
| <img alt="Imported by" src="https://sourcegraph.com/github.com/cosmos/cosmos-sdk/-/badge.svg" /> | ||
| </a> | ||
| <img alt="Sims" src="https://github.com/cosmos/cosmos-sdk/workflows/Sims/badge.svg" /> | ||
| <img alt="Lint Satus" src="https://github.com/cosmos/cosmos-sdk/workflows/Lint/badge.svg" /> | ||
| </div> | ||
|
|
||
| The Cosmos SDK is a framework for building blockchain applications. [Tendermint Core (BFT Consensus)](https://github.com/tendermint/tendermint) and the Cosmos SDK are written in the Golang programming language. Cosmos SDK is used to build [Gaia](https://github.com/cosmos/gaia), the first implementation of the Cosmos Hub. | ||
|
|
||
| **WARNING**: The Cosmos SDK has mostly stabilized, but we are still making some | ||
| breaking changes. | ||
|
|
||
| **Note**: Requires [Go 1.17+](https://golang.org/dl/) | ||
|
|
||
| ## Quick Start | ||
|
|
||
| To learn how the Cosmos SDK works from a high-level perspective, see the Cosmos SDK [High-Level Intro](./docs/intro/overview.md). | ||
|
|
||
| If you want to get started quickly and learn how to build on top of Cosmos SDK, visit [Cosmos SDK Tutorials](https://tutorials.cosmos.network). You can also fork the tutorial's repository to get started building your own Cosmos SDK application. | ||
|
|
||
| For more information, see the [Cosmos SDK Documentation](./docs/). | ||
|
|
||
| ## Cosmos Hub Mainnet | ||
|
|
||
| The Cosmos Hub application, `gaia`, has moved to its own [cosmos/gaia repository](https://github.com/cosmos/gaia). Go there to join the Cosmos Hub mainnet and more. | ||
|
|
||
| ## Inter-Blockchain Communication (IBC) | ||
|
|
||
| The IBC module for the Cosmos SDK has moved to its own [cosmos/ibc-go repository](https://github.com/cosmos/ibc-go). Go there to build and integrate with the IBC module. | ||
|
|
||
| ## Starport | ||
|
|
||
| Starport is the all-in-one platform to build, launch, and maintain any crypto application on a sovereign and secured blockchain. If you are building a new app or a new module, use [Starport](https://github.com/tendermint/starport) to get started and speed up development. | ||
|
|
||
| ## Disambiguation | ||
|
|
||
| This Cosmos SDK project is not related to the [React-Cosmos](https://github.com/react-cosmos/react-cosmos) project (yet). Many thanks to Evan Coury and Ovidiu (@skidding) for this Github organization name. As per our agreement, this disambiguation notice will stay here. | ||
| <!-- | ||
| parent: | ||
| order: false | ||
| --> | ||
|
|
||
| <div align="center"> | ||
| <h1> Cosmos SDK </h1> | ||
| </div> | ||
|
|
||
|  | ||
|
|
||
| <div align="center"> | ||
| <a href="https://github.com/cosmos/cosmos-sdk/releases/latest"> | ||
| <img alt="Version" src="https://img.shields.io/github/tag/cosmos/cosmos-sdk.svg" /> | ||
| </a> | ||
| <a href="https://github.com/cosmos/cosmos-sdk/blob/master/LICENSE"> | ||
| <img alt="License: Apache-2.0" src="https://img.shields.io/github/license/cosmos/cosmos-sdk.svg" /> | ||
| </a> | ||
| <a href="https://pkg.go.dev/github.com/cosmos/cosmos-sdk?tab=doc"> | ||
| <img alt="GoDoc" src="https://godoc.org/github.com/cosmos/cosmos-sdk?status.svg" /> | ||
| </a> | ||
| <a href="https://goreportcard.com/report/github.com/cosmos/cosmos-sdk"> | ||
| <img alt="Go report card" src="https://goreportcard.com/badge/github.com/cosmos/cosmos-sdk" /> | ||
| </a> | ||
| <a href="https://codecov.io/gh/cosmos/cosmos-sdk"> | ||
| <img alt="Code Coverage" src="https://codecov.io/gh/cosmos/cosmos-sdk/branch/master/graph/badge.svg" /> | ||
| </a> | ||
| </div> | ||
| <div align="center"> | ||
| <a href="https://github.com/cosmos/cosmos-sdk"> | ||
| <img alt="Lines Of Code" src="https://tokei.rs/b1/github/cosmos/cosmos-sdk" /> | ||
| </a> | ||
| <a href="https://discord.gg/AzefAFd"> | ||
| <img alt="Discord" src="https://img.shields.io/discord/669268347736686612.svg" /> | ||
| </a> | ||
| <a href="https://sourcegraph.com/github.com/cosmos/cosmos-sdk?badge"> | ||
| <img alt="Imported by" src="https://sourcegraph.com/github.com/cosmos/cosmos-sdk/-/badge.svg" /> | ||
| </a> | ||
| <img alt="Sims" src="https://github.com/cosmos/cosmos-sdk/workflows/Sims/badge.svg" /> | ||
| <img alt="Lint Satus" src="https://github.com/cosmos/cosmos-sdk/workflows/Lint/badge.svg" /> | ||
| </div> | ||
|
|
||
| The Cosmos SDK is a framework for building blockchain applications. [Tendermint Core (BFT Consensus)](https://github.com/tendermint/tendermint) and the Cosmos SDK are written in the Golang programming language. Cosmos SDK is used to build [Gaia](https://github.com/cosmos/gaia), the first implementation of the Cosmos Hub. | ||
|
|
||
| **WARNING**: The Cosmos SDK has mostly stabilized, but we are still making some | ||
| breaking changes. | ||
|
|
||
| **Note**: Requires [Go 1.17+](https://golang.org/dl/) | ||
|
|
||
| ## Quick Start | ||
|
|
||
| To learn how the Cosmos SDK works from a high-level perspective, see the Cosmos SDK [High-Level Intro](./docs/intro/overview.md). | ||
|
|
||
| If you want to get started quickly and learn how to build on top of Cosmos SDK, visit [Cosmos SDK Tutorials](https://tutorials.cosmos.network). You can also fork the tutorial's repository to get started building your own Cosmos SDK application. | ||
|
|
||
| For more information, see the [Cosmos SDK Documentation](./docs/). | ||
|
|
||
| ## Contributing | ||
|
|
||
| See [CONTRIBUTING.md](./CONTRIBUTING.md) for details how to contribute and participate in our [dev calls](./CONTRIBUTE.md#dev-calls). | ||
| If you want to follow the updates or learn more about the latest design then join our [Discord](https://discord.com/invite/cosmosnetwork). | ||
|
|
||
| ## Tools and Frameworks | ||
|
|
||
| The Cosmos ecosystem is vast. We will only make a few notable mentions here. | ||
|
|
||
| + [Tools](https://v1.cosmos.network/tools): notable frameworks and modules. | ||
| + [CosmJS](https://github.com/cosmos/cosmjs): the Swiss Army knife to power JavaScript based client solutions. | ||
|
|
||
| ### Cosmos Hub Mainnet | ||
|
|
||
| The Cosmos Hub application, `gaia`, has moved to its own [cosmos/gaia repository](https://github.com/cosmos/gaia). Go there to join the Cosmos Hub mainnet and more. | ||
|
|
||
| ### Inter-Blockchain Communication (IBC) | ||
|
|
||
| The IBC module for the Cosmos SDK has moved to its own [cosmos/ibc-go repository](https://github.com/cosmos/ibc-go). Go there to build and integrate with the IBC module. | ||
|
|
||
| ### Starport | ||
|
|
||
| Starport is the all-in-one platform to build, launch, and maintain any crypto application on a sovereign and secured blockchain. If you are building a new app or a new module, use [Starport](https://github.com/tendermint/starport) to get started and speed up development. | ||
|
|
||
| ## Disambiguation | ||
|
|
||
| This Cosmos SDK project is not related to the [React-Cosmos](https://github.com/react-cosmos/react-cosmos) project (yet). Many thanks to Evan Coury and Ovidiu (@skidding) for this Github organization name. As per our agreement, this disambiguation notice will stay here. |