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

Restructure modules to align with ibc-go's structure #1459

Merged
merged 13 commits into from
Oct 27, 2021
Merged

Restructure modules to align with ibc-go's structure #1459

merged 13 commits into from
Oct 27, 2021

Conversation

seanchen1991
Copy link
Contributor

@seanchen1991 seanchen1991 commented Oct 14, 2021

Address: #1436

Description

This PR adds modules/src/core, modules/src/clients, and modules/src/relayer directories (modules/src/applications already existed) and moves all of the ICS modules into the appropriate directories in order to adhere to the breakdown prescribed in the spec.

The modules/src/mock directory and the standalone files located in modules/src haven't been touched, though we should also figure out whether there are more appropriate locations for them and what those are.


For contributor use:

  • Added a changelog entry, using unclog.
  • If applicable: Unit tests written, added test to CI.
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Updated relevant documentation (docs/) and code comments.
  • Re-reviewed Files changed in the Github PR explorer.

Copy link
Member

@adizere adizere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2021-10-15 at 16 28 02

This looks so fresh so clean! Thanks Sean for spearheading this. Restructuring it was long overdue and will help with future adoption and code hygiene.

Approved! If we also update the docs.rs documentation for crate ibc this will deserve a 0.8 release.

Before merging this PR, however, I think we should announce it to current downstream dependencies and get their ACK (at the least), who will be affected by this breaking change. Comes to mind:

@adizere
Copy link
Member

adizere commented Oct 15, 2021

Should we also bite the bullet and rename modules directory into ibc? Not sure if we would be overreaching with that. It shouldn't affect any dependent project, but it will affect our repo namely the Cargo.tomls throughout.

Nevermind, it's not a big problem keeping it named modules.

@seanchen1991
Copy link
Contributor Author

If we also update the docs.rs documentation for crate ibc this will deserve a 0.8 release.

Updating the ibc crate documentation will be in a separate PR 🙂

@adizere adizere mentioned this pull request Oct 27, 2021
14 tasks
Copy link
Member

@adizere adizere left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Sean for patience with this! Great work!!

@seanchen1991 seanchen1991 merged commit 37d54d4 into informalsystems:master Oct 27, 2021
@seanchen1991 seanchen1991 deleted the restructure-to-ibc-go branch October 27, 2021 15:07
hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this pull request Sep 13, 2022
…ms#1459)

* Move ics modules into Client, Applications, and Core modules

* Fix broken imports in tests

* Fix some more broken imports in tests

* Fix broken imports in `telemetry`, `relayer`, and `relayer-cli`

* Run cargo fmt

* Fix more broken links

* Add changelog entry

* Update modules/lib.rs to reflect new directory structure

* Remove conflict marker in gitignore

* Flesh out lib.rs documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants