Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Documentation

Aperta
  • Qualcosa non va?
#5 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Ambito
documentation

Direzione di ricerca

Esamina le dichiarazioni del repository per identificare l'API pubblica IPLD che necessita di docstrings. Quindi verifica se doc-gen4 può generare la pagina di documentazione richiesta; il lavoro è completato quando le dichiarazioni sono documentate e viene registrata la fattibilità o la pagina di documentazione risultante.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation good first issue

Why

The repo is meant to provide an API for IPLD but it's currently undocumented, which makes its use harder (and maybe error prone)

How

  • Add docstrings to declarations
  • Check the possibility of using doc-gen4 to create a pretty documentation page
Lingua principale
Lean
Stelle
8
Fork
1
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.