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

Docs: Document code architecture and code reorg #445

Closed
adlrocha opened this issue Mar 9, 2023 · 1 comment
Closed

Docs: Document code architecture and code reorg #445

adlrocha opened this issue Mar 9, 2023 · 1 comment
Labels

Comments

@adlrocha
Copy link
Contributor

adlrocha commented Mar 9, 2023

As the code base is growing in the number of different crates each with different roles and responsibilities, we should create a README describing the code architecture, the different crates that conform the agent, how they are used, and their interactions. This will help external contributors navigate the code, and find the right place the may want to introduce their change to.

Additionally, as we do this exercise, we should consider a code reorganization to make the codebase cleaner and more accessible. E.g. we could divide the different handlers at https://github.com/consensus-shipyard/ipc-agent/tree/main/src/server/handlers by topic in different subcrates to prevent the number files to increase with the number of new commands in the agent. The commands here could also be organized topically to make it more readable.

TL;DR, make our code base a charm to read and work with.

@adlrocha
Copy link
Contributor Author

A bit of this has been implemented in consensus-shipyard/ipc-libs#148. Keeping it open to have a new pass after we have this pressing deadline to check if there is something else worth doing.

@jsoares jsoares transferred this issue from consensus-shipyard/ipc-libs Dec 19, 2023
@jsoares jsoares added the s:ipc label Dec 19, 2023
@jsoares jsoares closed this as not planned Won't fix, can't repro, duplicate, stale Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants