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

Document multi-module best practices and usage #10924

Closed
aaronc opened this issue Jan 10, 2022 · 2 comments
Closed

Document multi-module best practices and usage #10924

aaronc opened this issue Jan 10, 2022 · 2 comments
Assignees

Comments

@aaronc
Copy link
Member

aaronc commented Jan 10, 2022

As we switch to a more multi-module repo. We will need to have clear documentation on best practices for working with sub-modules. Things are not obvious, for example see #10915.

Things that need be clear as best practices for developers:

For users of modules, we need to:

Any ideas on how to approach this @marbar3778 @AmauryM @robert-zaremba ?

@robert-zaremba
Copy link
Collaborator

We need to:

  1. update instructions for starting building a new chain / app
  2. check with starport team
  3. verify if depend bot works in a multi-module setup and add recommendation to use it.

make sure there is some master SDK core dependency which references everything

simapp should work, right?

@julienrbrt
Copy link
Member

Let's consider this as completed.

We have dependabot using the script when bumping dependencies in all modules: https://github.com/cosmos/cosmos-sdk/blob/main/.github/workflows/dependabot-update-all.yml
We have described the tagging process of submodules: https://github.com/cosmos/cosmos-sdk/blob/main/RELEASE_PROCESS.md#cosmos-sdk-modules
Each submodule has their tests, sonarcould: https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#gomod
Sub modules in release branches are always using the latest commit from their modules, and when in development (no tag yet), the process in explained in the release notes: https://github.com/cosmos/cosmos-sdk/releases/tag/v0.50.0-rc.0
The only thing we need is a compatibility matrix: #17487 (a bit broader than one in this issue however)

@github-project-automation github-project-automation bot moved this from Ice Box to Done in Cosmos SDK: Framework WG Nov 16, 2023
@github-project-automation github-project-automation bot moved this from 👀 To Do to 🥳 Done in Cosmos-SDK Nov 16, 2023
@tac0turtle tac0turtle removed this from Cosmos-SDK Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

No branches or pull requests

4 participants