Add comments and type hints to Python code

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

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Refactorisation
Clarté
À clarifier
Activité
À l'abandon
Stack technique
python
Domaine
developer-experience

Piste de recherche

L’issue ne nomme aucun fichier, test ni point d’entrée. Commencez par inventorier le code Python et définir quels modules sont concernés, puis ajoutez des commentaires et des annotations de type de manière cohérente ; c’est terminé lorsque le périmètre convenu est documenté et que le code mis à jour reste fonctionnel.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

enhancement

The python code current has nearly zero comments, which makes it difficult for people to figure out what the code is actually doing. Having comments would make it easier for people who are less familar with python and this specific codebase to contribute. Type hints would also be a useful addition for similar reasons.

Langage dominant
Python
Étoiles
12
Forks
40
Merge moyen
1 j 13 h
PR mergées (30 j)
1

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.

Autres issues de ComputerScienceHouse/conditional

Toutes les issues de ComputerScienceHouse/conditional

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

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