filecoin-project/go-data-transfer

The README is well out of date

Open

#282 opened on Nov 16, 2021

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)Go (13 forks)github user discovery
good first issue

Repository metrics

Stars
 (41 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The README's instructions are well out of date and in need of an update, at minimum so the syntax and instructions are correct. We should also probably add sections about revalidators and validators

Contributor guide

Research direction
Review the current README and compare with the project's current state. Update syntax and instructions, and add sections about revalidators and validators.
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.
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
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90