[mkdocs] Improve descriptions
Ouverte
Personne n'a encore pris cette issue.
documentation
P2
- Langage dominant
- Python
- Étoiles
- 18.8k
- Forks
- 2.8k
- Merge moyen
- 16 h 26 min
- PR mergées (30 j)
- 21
Description
Looking at https://github.com/daexs/plotly.py/pull/80/files, some of the descriptions are very short and not informative.
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 les modifications apportées aux fichiers et aux descriptions présentées dans la pull request référencée. Identifiez les descriptions qui sont trop courtes ou peu informatives, puis mettez-les à jour afin que la documentation concernée soit plus claire ; le travail est considéré comme terminé lorsque les descriptions pertinentes fournissent un contexte utile sans être inutilement succinctes.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 35/100