From 3cc2e4f95787bfd6b92fa04a0956c1443f846882 Mon Sep 17 00:00:00 2001 From: justin0u0 Date: Thu, 5 May 2022 01:36:41 +0800 Subject: [PATCH] chore: update README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c660ec6..1370bd0 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ The implementation will be divided into 2 parts: leader election, log replicatio # Getting Started -Download the Raft template [https://github.com/justin0u0/raft/archive/refs/tags/template.zip](https://github.com/justin0u0/raft/archive/refs/tags/template.zip). +Download the Raft template [https://github.com/justin0u0/raft/archive/refs/tags/template-v1.0.0.zip](https://github.com/justin0u0/raft/archive/refs/tags/template-v1.0.0.zip). Note that for all `TODO`s without a `*`, the description can be found in the paper figure 2. @@ -184,6 +184,8 @@ go test -timeout 60s -race -count 1 ./... > 💡 You can add `-v` flag when testing to show all logs even if the test pass. +If the test does not pass, it is suggested to understand what is the test testing for, then using the log to find out bugs and errors. For example, the `TestLogReplicationWithFollowerFailure` test is testing for “a disconnected follower should not affect the log replication to other followers” and “after the follower comes back, the missing logs should be replicated to the follower”. If you have hard time understanding the test cases, please feel free to contact me 😊。 + # Future Work There are many other works can be done to improve the Raft we designed, the following are some: