ProtoDef-io / ProtoDef-io/node-protodef
Make API methods names clearer : comply to abstract-encoding
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 25
- Avg merge
- 4d 3m
- Merged PRs (30d)
- 2
Description
https://github.com/mafintosh/abstract-encoding is nice and it looks like node-protodef createPacketBuffer and parsePacketBuffer could fit that api.
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 with the public createPacketBuffer and parsePacketBuffer entry points in node-protodef and compare their naming with the abstract-encoding API linked in the issue. Determine the intended clearer names and update the affected API references; done when node-protodef follows the target naming consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100