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

Provide correct documentation for `hedera-node/hapi-utils`

Open
#13,137 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

HapiThursday
Dominant language
Java
Stars
407
Forks
226
Avg merge
3d 4h
Merged PRs (30d)
210

Description

Consider hedera-node/hapi-utils. It contains a bunch of utility classes that I guess in some way are "hapi" utilities.

But the README.md doesn't describe them - or even the rule by which you'd find some utility class in this directory vs. some other (more specific?) directory.

In fact, the README.md is from a bygone era when this directory held the compiled protobufs from the protobuf repo. (I think.). And that also explains why there's this giant file HAPI.html describing the protobufs (and it's way out of date).

So this issue is:

  1. Remove the existing README.md and HAPI.html - no longer applicable here.
  2. Add a new README.md that properly describes the contents of this directory (and the decision rule you use to decide whether to place your own new utility class here, or somewhere else).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting hedera-node/hapi-utils/README.md and HAPI.html, then review the utility classes in that directory and nearby specific utility directories. Done means the obsolete README.md and HAPI.html are removed and a new README.md explains the directory contents and the rule for placing new utility classes here or elsewhere.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.