pyupio/safety

Documentation Improvements

Open

#572 ouverte le 14 août 2024

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Python (135 forks)batch import
good first issue

Métriques du dépôt

Stars
 (1 557 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

This issue is intended to encourage continuous improvement of the documentation across the repository. We are looking for contributions that enhance clarity, add examples, or update existing documentation to better reflect current functionality. If you notice an area of the documentation that could benefit from an update or expansion, please feel free to contribute! After making your changes, create a new issue describing what you’ve done and link it to this general documentation improvement issue.

Guide contributeur

Direction de recherche
Commencez par examiner le README du projet, le guide de contribution et toute autre documentation dans le dépôt. Identifiez les zones qui manquent de clarté, sont dépourvues d'exemples ou contiennent des informations obsolètes. Vous pouvez également consulter le suivi des problèmes du dépôt pour des demandes spécifiques de documentation. Après avoir apporté des améliorations, créez un nouveau problème décrivant vos modifications et liez le à ce problème. Respectez le style et le ton de la documentation du projet.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85