Add more comments
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 3.7k
- Forks
- 676
- Avg merge
- 4d 9h
- Merged PRs (30d)
- 6
Description
Few places which could use more comments:
https://github.com/docker/swarmkit/blob/master/manager/state/raft/raft.go#L545
https://github.com/docker/swarmkit/blob/master/manager/state/raft/raft.go#L566
https://github.com/docker/swarmkit/blob/master/manager/state/raft/raft.go#L632
https://github.com/docker/swarmkit/blob/master/manager/state/raft/raft.go#L681
https://github.com/docker/swarmkit/blob/master/manager/state/raft/raft.go#L714
There is code in store which would also be more readable with more comments.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the referenced sections of manager/state/raft/raft.go at lines 545, 566, 632, 681, and 714, then inspect the store code mentioned in the issue. Identify the behavior that is difficult to follow and add explanatory comments at those locations. Done means the listed raft sections and the relevant store code are more readable without changing behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- distributed-systems, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100