cloudevents / cloudevents/sdk-python
Improve in-code documentation
Personne n'a encore pris cette issue.
- Langage dominant
- Python
- Étoiles
- 342
- Forks
- 65
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
Almost all code now lacks proper pydocs across almost all the codebase. We should consider the following PRs are gonna improve the situation.
It should be prohibited to merge PRs that do not have docs. We should eventually cover all the missing places with appropriate documentation and examples.
Guide de contribution
Ouvrir le guide de contribution
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 examiner la base de code Python à la recherche de pydocs manquantes et par passer en revue les PRs proposées mentionnées dans l’issue. Le périmètre couvre la documentation et les exemples dans la quasi-totalité du code, ainsi qu’une politique visant à empêcher les PRs non documentées. Pour considérer le travail comme terminé, il faudrait disposer d’une approche convenue et d’une couverture étendue de la documentation manquante.
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é
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 20/100