Guia d'estil per a desenvolupadors
Aquest document recull les pràctiques que s'han de seguir si voleu contribuïr al codi de MailToTicket.
MailToTicket està implementat en Python v2.7.
A més dels requisits del propi codi del projecte, també utilitza aquests paquets per les comprovacions de qualitat (les podeu instal·lar amb pip):
- pep8
- radon
A l'hora de codificar s'han de seguir les recomanacions descrites al document PEP8.
Podeu configurar aquest hook de git per comprovar la sintaxi i els tests abans d'acceptar un commit al fitxer .git/hooks/pre-commit (vegeu l'exemple pre-commit.sample del repositori de codi).
Si feu servir l'entorn de desenvolupament PyDev, podeu configurar-ho per formatar el codi seguint les regles del PEP8. Per fer-ho, aneu a la opció Window -> Preferences, i al panell esquerre aneu a l'apartat PyDev -> Editor -> Code Style -> Formatter i activeu la casella etiquetada «Use autopep8.py for code formatting?».
En PyDev la drecera per formatar el codi del fitxer actual és Ctrl+f.
Si voleu que PyDev formati el codi automàticament cada cop que guardeu el fitxer, aneu al menú Window -> Preferences, i al panell esquerre aneu a l'apartat PyDev -> Editor -> Save Actions i marqueu la casella etiquetada «Autoformat editor contents before saving?».
El Travis utilitza contenidors amb recursos limitats que de vegades poden donar maldecaps. Per investigar com depurar aquests problemes es poden utilitzar les imatges de Docker al vostre ordinador.
Us caldrà tenir instal·lat el paquet jq del sistema:
-
Obtenir els resultats per un fitxer:
radon cc --codeclimate filtres/nou.py | jq . -
Veure l'explicació de la puntuació:
echo -e $(radon cc --codeclimate filtres/nou.py | jq .content.body)