Skip to content

Latest commit

 

History

History
33 lines (18 loc) · 2.44 KB

README.md

File metadata and controls

33 lines (18 loc) · 2.44 KB
Raw

Cosmos Modules

banner

license

Note: This repository is meant to house modules that are created outside of the Cosmos-SDK repository.

Note: Requires Go 1.13+

Quick Start

To learn how the SDK works from a high-level perspective, go to the SDK Intro.

If you want to get started quickly and learn how to build on top of the SDK, please follow the SDK Application Tutorial. You can also fork the tutorial's repo to get started building your own Cosmos SDK application.

For more, please go to the Cosmos SDK Docs

To find out more about the Cosmos-SDK, you can find documentation here.

This repo organizes modules into 3 subfolders:

  • stable/: this folder houses modules that are stable, production-ready, and well-maintained.
  • incubator/: this folder houses modules that are buildable but makes no guarantees on stability or production-readiness. Once a module meets all requirements specified in contributing guidelines, the owners can make a PR to move module into stable/ folder. Must be approved by at least one modules maintainer for the module to be moved.
  • inactive/: Any stale module from the previous 2 folders may be moved to the inactive folder if it is no longer being maintained by its owners. modules maintainers reserve the right to move a module into this folder after public discussion in an issue and a specified grace period for module owners to restart work on module.

Any changes to where modules are located will only happen on major releases of the modules repo to ensure we only break import paths on major releases.

Modules maintainers

While each individual module will be owned and maintained by the individual contributors of that module, there will need to be maintainers of the modules repo overall to coordinate moving modules between the different folders and enforcing the requirements for inclusion in the modules repo.

For now, the maintainers of the modules repo will be the SDK team but we intend to eventually expand this responsibility to other members of the Cosmos community.