go-delve/delve

Internal Documentation

Open

#1074 opened on Jan 9, 2018

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (24,010 stars) (2,177 forks)batch import
help wanted

Description

I've noticed the Internal Documentation remains empty. I'd like to contribute to it, as I see it as a great opportunity to know more about Delve and also Go internals.

I'm new here and I realize that understanding Delve's internals isn't an easy task (the TODO is assigned to its creator) but I just aim at getting the ball rolling contributing some minor PRs with whatever useful information I can provide.

I'm raising this issue to check if you think this is a doable task and see if any of the maintainers would be willing to provide me with some guidance of where to start, and answer some questions along the way (which I'll try to make as concrete as I can to take as little time from you as possible).

Contributor guide

Tech stack
go
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Go programming languagebasic debugging concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Start by exploring the Documentation/internal directory. Review existing external documentation to understand structure. Ask maintainers for starting points in the codebase. Focus on documenting one internal component at a time, such as the command handling or breakpoints.