linkedin / linkedin/python-avro-json-serializer
Better doc
Nessuno ha ancora preso questa issue.
- Lingua principale
- Python
- Stelle
- 135
- Fork
- 43
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Descrizione
Hi,
I'm a user of your library, it's great.
I had a couple of suggestion to improve the doc:
- add how to install w/ pip
- add imports statement to the examples
- add deserialize example
I can actually do it if you want.
Guida per i contributori
Nessuna guida per i contributori indicizzata per questo repository
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Direzione di ricerca
Inizia individuando la documentazione e gli esempi attuali del progetto, quindi esamina come sono attualmente descritte l’installazione e la serializzazione. Aggiorna la documentazione per includere l’installazione con pip, gli imports negli esempi e un esempio di deserialize; il lavoro è completato quando tutte e tre le richieste sono coperte e gli esempi rimangono comprensibili.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Valutazione
- Stack tecnologico
- python
- Ambito
- documentation
- Tipo di issue
- Documentazione
- Difficoltà
- 2/5
- Tempo stimato
- Mezza giornata
- Stato di attività
- Ferma
- Chiarezza
- Abbastanza chiara
- Idoneità per principianti
- 45/100