Rust Docs + refactor: roles
crates
#1117
Labels
documentation
Improvements or additions to documentation
needs-more-planning
refactor
Implies refactoring code
roles
Pertains to all roles
tracker
Help us track a group of related issues
Background
Currently, the
protocols
androles
crates are not production ready and contain code debt that needs to be addressed. This effort is discussed in #1069. Theprotocols
tracker issue is in #845. This issue's purpose is the same as #845, only is directed at theroles
crates.The high-level process will be (see this comment in discussion 1069 for a more detailed plan of action)
protocols
Rust docs and identify any code debt (includingpanic
s,todo
s, andunimplemented
s). Note that theprotocols
crates are fairly set and major architecture changes are not anticipated.roles
Rust docs and identify code debt. Note that these crates will likely have notable architecture changes.protocols
changes.roles
changes.Along side of this effort is #270 (and perhaps others, @plebhash?), which aims to address critical message generator issues. This initial message generator work would be to fix the critical issues, but these changes should/will be made mindfully as to introduce as little change as possible to not interfere with the overall/long term protocols and roles refactor effort.
Task List
Rust Docs
Refactor Implementation
Roles
as a prepration for integration tests #1093The text was updated successfully, but these errors were encountered: