jackyzha0 / miniraft

🚣‍♀️ <1kloc, well-documented Raft consensus algorithm implementation

miniraft

A <1kloc, well-documented Raft consensus algorithm implementation

This crate is a minimal implementation of the Raft consensus protocol with a focus on readability/understandability.

All logic related to the Raft algorithm can be found under src. Main files of note are src/server.rs which contains the implementation for a single Raft node and src/log.rs which contains the implementation for an event log which is the basis for the replicated log at the core of Raft.

This project was created as an exercise in implementing and learning about distributed systems. Do NOT use this in production.

• Crate Documentation
• Specification

miniraft's Issues

Documentation for tests

The documentation in src is really helpful, but the tests are where things get put into practice. It would be helpful to have comments in the tests and around TestCluster to explain what is going on and how.

I would make a PR, but I'm not sure I really understand what's going on here :)