NethermindEth / NethermindEth/Catalyst
[Rust workspace] define public API surface and document all public API
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 44
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
In crates node and p2p-network
- methods
- struct fields
- consts
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 inspecting the public items in the node and p2p-network crates, covering methods, struct fields, and constants. Determine which items belong to the public API and document each included item. The work is done when the public API surface for both crates is defined and all included items are documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100