linkedin / linkedin/python-avro-json-serializer
Better doc
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 135
- Forks
- 43
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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.
Guide de contribution
Aucun guide de contribution indexé pour ce dépôt
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par localiser la documentation et les exemples actuels du projet, puis examinez la manière dont l’installation et la sérialisation sont actuellement décrites. Mettez à jour la documentation pour inclure l’installation avec pip, les imports dans les exemples et un exemple de deserialize ; le travail est terminé lorsque les trois demandes sont couvertes et que les exemples restent compréhensibles.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- python
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- Une demi-journée
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100