You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
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.
The text was updated successfully, but these errors were encountered: