Standardizing the formats of libp2p specs
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 1.8k
- Forks
- 320
- Avg merge
- 11d 15h
- Merged PRs (30d)
- 1
Description
I noticed that you folks at Protocol Labs have been focusing on cleaning up and improving the libp2p specs, in addition to adding new specs. Great work! However, one major thing I noticed across all the specs in this repo is the lack of structure across all the specs. Every spec writer has their own way of writing specs and as such we end up with a lot of different styles of specifications. This will bring a lot of problems as more community members start implementing their own libp2p compliant modules in various programming languages.
I suggest that libp2p specs have a standard way that spec writers write specs. I would suggest taking a look at how the IETF and W3C write specifications that are standardized.
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 reviewing the existing libp2p specifications and comparing their structures with IETF and W3C specifications, as suggested in the issue. Define a consistent format for future spec writers and establish what existing specifications, if any, should be updated to match it.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100