ipfs/go-graphsync

Document internal methods on RequestManager and ResponseManager

Open

#221 opened on Sep 24, 2021

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)Go (41 forks)github user discovery
P2effort/hoursexp/intermediategood first issue

Repository metrics

Stars
 (103 stars)
PR merge metrics
 (Avg merge 2h 10m) (5 merged PRs in 30d)

Description

Add comments explaining what they do, consider renaming them as need.

Add unit tests that actually check behavior where needed.

Contributor guide

Research direction
Read the existing code for RequestManager and ResponseManager, write comments explaining each method's purpose, and add unit tests to verify behavior.
Tech stack
go
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75