pyupio/safety

Documentation Improvements

Open

#572 aperta il 14 ago 2024

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)Python (135 fork)batch import
good first issue

Metriche repository

Star
 (1557 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Inizia rivedendo il README del progetto, la guida ai contributi e qualsiasi altra documentazione nel repository. Identifica le aree che mancano di chiarezza, sono prive di esempi o contengono informazioni obsolete. Puoi anche controllare il tracker delle issue del repository per richieste specifiche di documentazione. Dopo aver apportato miglioramenti, crea una nuova issue che descriva le tue modifiche e collegala a questa issue. Atteniti allo stile e al tono della documentazione del progetto.
Tech stack
python
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85