marigold-dev / marigold-dev/pollinate
Rename PNode
Nobody has claimed this yet.
- Dominant language
- OCaml
- Stars
- 22
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Description
## Rename `node` library
Obviously, `node` is the perfect name for this library, but it leads to confusion for `dune` when using it on Deku (I guess, the struggle will be the same for a lot of blockchain client...)
[Quick description of the change you want to make or add]
`Client` and `Node` cannot be merged because of dependency cycle with `Failure_detector`.
Going for a synonym of `Node` like `knot` looks not pretty good, and using a flower term, doesn't seem explicit enough (`pistil` for example)
Contributor guide
No contributing guide indexed for this repository
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 locating the OCaml library and Dune references to `node`; the issue does not name any files or tests. First determine and agree on the replacement name, then identify all affected references and dependency boundaries involving `Client`, `Node`, and `Failure_detector`. Done means the library is consistently renamed without reintroducing the dependency cycle and the project still builds.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- networking
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100