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

Fix Recommended Folder Structure section #17919

Closed
kakysha opened this issue Sep 28, 2023 · 2 comments · Fixed by #20907
Closed

Fix Recommended Folder Structure section #17919

kakysha opened this issue Sep 28, 2023 · 2 comments · Fixed by #20907
Assignees
Labels
T:Docs Changes and features related to documentation.

Comments

@kakysha
Copy link

kakysha commented Sep 28, 2023

Right now the Building Modules > Recommended Module Structure advocates to put all type definitions into root module folder, while this is almost never possible due to circular references between module package and keeper package (module.go in root package needs reference to keeper, and keeper needs references to almost all module types defined in root package).
Besides that, never seen any module that follows these pattern, I suppose exactly due to this reason. All modules keep using separate types package instead of placing type definitions inside root folder.

@julienrbrt
Copy link
Member

julienrbrt commented Sep 28, 2023

x/group and x/nft follow it.
But that's true that it is not being followed by all modules.

However if you follow it you still do not have circular dependencies as you have a keeper and a module package.

@julienrbrt julienrbrt transferred this issue from cosmos/cosmos-sdk-docs Sep 28, 2023
@julienrbrt julienrbrt added the T:Docs Changes and features related to documentation. label Sep 28, 2023
@github-actions github-actions bot added the needs-triage Issue that needs to be triaged label Sep 28, 2023
@julienrbrt julienrbrt removed the needs-triage Issue that needs to be triaged label Sep 28, 2023
@julienrbrt
Copy link
Member

For reference: #17657 (comment)

@github-project-automation github-project-automation bot moved this to 👀 To Do in Cosmos-SDK Nov 17, 2023
@sontrinh16 sontrinh16 self-assigned this Jul 9, 2024
@github-project-automation github-project-automation bot moved this from 📋 Backlog to 🥳 Done in Cosmos-SDK Jul 9, 2024
@tac0turtle tac0turtle removed this from Cosmos-SDK Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants