Describe situations when every packet is used
Open
Nobody has claimed this yet.
discussion
documentation
priority: low
- Dominant language
- Perl
- Stars
- 1.5k
- Forks
- 1.2k
- PR merge metrics
- No merged PRs in 30d
Description
Especially for unusual packets (or for unusual situations for usual packets) we should have all observed usage described in comments, nearby handler function or where applicable.
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
Review the packet-handling code and identify where packet usage is currently undocumented, focusing on unusual packets and unusual situations for common packets. Done means adding comments near the relevant handler functions or other applicable locations that describe all observed usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- perl
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 32/100