hiero-ledger / hiero-ledger/hiero-consensus-node

FCHashMap code readability and documentation improvement

Open
#5,370 3 comments 0 reactions 1 assignee Claimed by @deepak-swirlds View on GitHub
Platform
Dominant language
Java
Stars
406
Forks
226
Avg merge
3d 4h
Merged PRs (30d)
210

Description

I recently spent time reviewing PR: https://github.com/swirlds/swirlds-platform/pull/6447
Without diagrams and documentation it was very hard to read to make sense of.

Anybody who needs to understand that code would have a very hard time and either will have to reach out to the author or as most developers do just be brave and spend a lot of time reading it.

Based on personal experience
1. A few simple diagrams preferably embedded to the javadoc
2. Naming variables as close to the problem they solve, though this is always difficult to get it right
3. Add succinct (tricky) documentation at the right(tricky) places

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.