Add example in readme

Aperta
#236 3 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
30/100
Tipo di issue
Documentazione
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Inizia leggendo il README del repository e rivedendo i punti di ingresso pubblici TypeScript della libreria per comprendere la documentazione sull'utilizzo attuale. Aggiungi nel README un esempio concreto di utilizzo e una spiegazione di supporto; la documentazione è completa quando un nuovo utente può seguire l'esempio per utilizzare correttamente la libreria.

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

Descrizione

good first issue help wanted prio-low scope-documentation

we should have better usage docs for this library

cc @holgerd77

Lingua principale
TypeScript
Stelle
31
Fork
22
Metriche di merge delle PR
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.

Altre issue di ChainSafe/discv5

Tutte le issue di ChainSafe/discv5

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.