ipld/go-car

Index documentation

Open

#306 opened on Jun 2, 2022

View on GitHub
 (1 comment) (0 reactions) (1 assignee)Go (54 forks)github user discovery
exp/intermediatehelp wanted

Repository metrics

Stars
 (176 stars)
PR merge metrics
 (Avg merge 23h 30m) (12 merged PRs in 30d)

Description

I'm trying to grasp how the indexes in this repo work, what they are good for, the pro/cons of each, but I end up reading the code to try to figure out what's happening.

Would you mind writing a minimal doc for each explaining those? That'd really help.

Contributor guide

Research direction
Read the existing code for each index type in the repo and document their purpose, pros, and cons based on the implementation.
Tech stack
go
Domain
documentationbackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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
GitGo basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85