Add comments and type hints to Python code

Aperta
#415 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Refactoring
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
python
Ambito
developer-experience

Direzione di ricerca

La issue non indica file, test o punti di ingresso. Inizia facendo un inventario del codice Python e definendo quali moduli rientrano nell’ambito, quindi aggiungi commenti e annotazioni di tipo in modo coerente; il lavoro è completato quando l’ambito concordato è documentato e il codice aggiornato continua a funzionare.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Python
Stelle
12
Fork
40
Merge medio
1g 2h
PR unite (30g)
2

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ComputerScienceHouse/conditional

Tutte le issue di ComputerScienceHouse/conditional

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.