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

Rust Docs + refactor: roles crates #1117

Closed
2 tasks
rrybarczyk opened this issue Aug 19, 2024 · 3 comments
Closed
2 tasks

Rust Docs + refactor: roles crates #1117

rrybarczyk opened this issue Aug 19, 2024 · 3 comments
Assignees
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

Comments

@rrybarczyk
Copy link
Collaborator

rrybarczyk commented Aug 19, 2024

Background

Currently, the protocols and roles crates are not production ready and contain code debt that needs to be addressed. This effort is discussed in #1069. The protocols tracker issue is in #845. This issue's purpose is the same as #845, only is directed at the roles crates.

The high-level process will be (see this comment in discussion 1069 for a more detailed plan of action)

  1. Complete protocols Rust docs and identify any code debt (including panics, todos, and unimplementeds). Note that the protocols crates are fairly set and major architecture changes are not anticipated.
  2. Complete roles Rust docs and identify code debt. Note that these crates will likely have notable architecture changes.
  3. Implement protocols changes.
  4. Implement 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

@rrybarczyk rrybarczyk added documentation Improvements or additions to documentation tracker Help us track a group of related issues refactor Implies refactoring code roles Pertains to all roles labels Aug 19, 2024
@plebhash
Copy link
Collaborator

adding a new label needs-more-planning here to explicitly state that this is not actionable yet

#845 should be prioritized over this

@rrybarczyk
Copy link
Collaborator Author

Let's keep track of all of these issues in #1069 in this comment.

This choice is made because the roles refactor involves architecture changes and some of the roles issues may actually not be needed after that architecture is set, so an issue to track them may be premature, but the discussion is a good spot.

@Fi3
Copy link
Collaborator

Fi3 commented Aug 21, 2024

protocols IMO are prod ready. Are very well tested and they work well, there aren't any perf issues that I'm aware of. The only thing that is needed it better documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

4 participants