https://github.com/cosmos/modules

https://github.com/cosmos/modules

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/cosmos/modules
• Owner: cosmos
• License: other
• Archived: true
• Created: 2019-10-03T15:45:05.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-11-28T14:13:48.000Z (12 months ago)
• Last Synced: 2024-08-01T13:28:17.316Z (3 months ago)
• Language: Go
• Size: 467 KB
• Stars: 44
• Watchers: 16
• Forks: 30
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - cosmos/modules - (Go)

README

        
# Cosmos Modules

![banner](cosmos-sdk-image.jpg)

[![license](https://img.shields.io/github/license/cosmos/cosmos-sdk.svg)](https://github.com/cosmos/modules/blob/master/LICENSE)

**Note**: This repository is meant to house modules that are created outside of the [Cosmos-SDK](https://github.com/cosmos/cosmos-sdk) repository.

**Note**: Requires [Go 1.13+](https://golang.org/dl/)

## Quick Start

To learn how the SDK works from a high-level perspective, go to the [SDK Intro](https://docs.cosmos.network/master/intro/overview.html).

If you want to get started quickly and learn how to build on top of the SDK, please follow the [SDK Application Tutorial](https://github.com/cosmos/sdk-tutorials). 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](https://github.com/cosmos/cosmos-sdk/docs/README.md)

To find out more about the Cosmos-SDK, you can find documentation [here](https://cosmos.network/docs/).

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](./CONTRIBUTING.md), 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.