Add an example for hole punching
Open
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 72
- Forks
- 97
- PR merge metrics
- No merged PRs in 30d
Description
We should add an example for hole punching in go-libp2p similar to https://docs.rs/libp2p/latest/libp2p/tutorials/hole_punching/index.html
This request comes up every once a while on the slack channel or on go-libp2p issues. This looks like the right place to address it.
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 reading the linked Rust libp2p hole-punching tutorial and inspecting the go-libp2p documentation site for the appropriate example location. Adapt the relevant concept for go-libp2p and document a working hole-punching example; the example should be understandable and usable from the published documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100