Skip to content

Review #10

@Helias

Description

@Helias

PROs

  • conventional commits utilizzati correttamente (feat, fix, test, refactor, docs, ci, chore, style)
  • 93% code coverage
  • codice tipizzato con type hints
  • buona directory structure
  • uso di test parametrizzati e pytest-asyncio per i test asincroni
  • uso corretto di .env e .env.example per le variabili d'ambiente
  • separazione tra requirements.txt e requirements_dev.txt
  • nessun file sorgente eccessivamente grande (il piu' grande è buttons.py con 193 righe)
  • uso di internazionalizzazione (i18n) con file JSON per italiano e inglese

CONs

  • 9 PRs, sono un po' poche per 3 developers
  • il README è interamente scritto in italiano, sarebbe meglio scriverlo in inglese per renderlo accessibile a un pubblico internazionale
  • ci sono commenti in italiano nel codice sorgente: buttons.py riga 45, sarebbe meglio usare solo l'inglese
  • responses è presente in requirements.txt (dipendenze di produzione) ma non viene mai utilizzato in nessun file del progetto, andrebbe rimosso
  • minor: handlers.py disabilita globalmente la regola pylint unused-argument con un commento in cima al file (# pylint: disable=unused-argument). Anche se è comprensibile dato che i callback di python-telegram-bot richiedono il parametro context anche quando non viene usato, sarebbe piu' pulito usare il disable inline solo sulle funzioni specifiche dove serve, oppure rinominare il parametro con un underscore (es. _context)
  • minor: getAboutString e getServiceString in messages.py usano camelCase invece di snake_case, che è la convenzione standard di Python (PEP 8)
  • minor: al comando /start il bot potrebbe elencare i comandi disponibili

Complessivamente il progetto è ben strutturato e ben testato. Ottimo lavoro. 🏁

P.S. potreste lasciare il bot online e linkare l'username del bot nel README 😉

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions