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

Better doc

Aperta
#9 2 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
Mezza giornata
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
documentation

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.

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.

Lingua principale
Python
Stelle
135
Fork
43
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

Non abbiamo ancora controllato i file di configurazione di questo progetto. 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 linkedin/python-avro-json-serializer

Tutte le issue di linkedin/python-avro-json-serializer

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.