JSellers0 / JSellers0/PythonTimeClock_Flask_WebApp

None of your shit is documented

Ouverte
#6 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

documentation enhancement good first issue
Langage dominant
Python
Étoiles
0
Forks
0
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

No Docstrings. Limited commenting.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

L’issue ne nomme aucun fichier, test ni point d’entrée. Commencez donc par examiner la structure du projet Python et identifier les zones de code dépourvues de docstrings ou de commentaires utiles. Définissez le périmètre de la documentation avant d’effectuer les modifications ; le travail doit être considéré comme terminé lorsque les zones de code convenues disposent de docstrings appropriés et que les lacunes limitées dans les commentaires ont été comblées.

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é
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.