Criterios de Validación de Código

Adaptado de: Clean Code, Robert C. Martin - Prentice Hall, 2009

• Código escrito íntegramente en inglés

• Nombres de variables, funciones, clases y atributos que reflejen la intención del código (qué es lo que hace)

• Los nombres de las clases deben ser sustantivos. Los nombres de los métodos y funciones deben ser acciones.

• Accessors deben tener el prefijo "get_".

• Mutators deben tener el prefijo "set_".

• Predicados deben tener el prefijo "is_".

• Funciones pequeñas:

  • Aceptación: no más de 20 líneas
  • Revisión cuidadosa: no más de 50 líneas
  • Rechazo: 50 líneas o más

• Nivel de indentación máximo permitido: 2, sin considerar el obligatorio en definición de funciones

• Una función debe tener un ÚNICO propósito: un nivel de abstracción por función.

• Idealmente, una función no debe recibir más de dos argumentos.

• Toda función debe estar cubierta por tests.

• Evitar el uso de comentarios dentro del código.

Reglas de formato

• 4 espacios, sin tabs, sacar espacios al final de las lineas
• Para el formato del código utilizaremos pep8, el cual se instala como pip install pep8 y se ejecuta como pep8 nombre_app
• Las convenciones para nombres de vistas y templates de django detalladas acá.