linkedin / linkedin/python-avro-json-serializer
Better doc
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 135
- Forks
- 43
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, die aktuelle Dokumentation und die Beispiele des Projekts zu finden, und prüfe anschließend, wie Installation und Serialisierung derzeit beschrieben werden. Aktualisiere die Dokumentation so, dass sie die Installation mit pip, Imports in den Beispielen und ein deserialize-Beispiel enthält; abgeschlossen ist die Aufgabe, wenn alle drei Anforderungen abgedeckt sind und die Beispiele verständlich bleiben.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- Ein halber Tag
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100