Consideraciones y buenas practicas al momento de codificar

• Este proyecto esta diseñado para poder ser tanto desplegado como utilizado en un entorno de desarrollo.
• El código será leido y revisado por varias personas, por lo tanto, debe ser codificado de manera que sea fácilmente comprensible para quienes lo lean. Se deben evitar errores simples como:

// No es facil de leer:
$n = 'Tanil'; //nombre

// Mas facil de leer:
$nombre = 'Tanil';

• La codificación, en lo posible, se realizara en idioma español, evitar nombres en ingles en codigo generado por nosotros.
• Deberemos generar codigo en camel case empezando por la primera letra minuscula (nombrandoCosasDeEstaManera), ya que asi esta generada por convencion en Laravel. Los metodos propios de php estan en snake case (de_esta_manera) y de necesitar usarse no hay ningun problema.
• Detallando en el punto anterior, Laravel sigue los estandares de codificacion PSR-1 y PSR-4 las cuales vale la pena hojear para generar codigo estandar.
• En migraciones y campos como $fillable = ['atributo', 'otro_atributo'], asi como en los nombres de los campos de los requests y responses se debe utilizar snake_case.
• Utilizar los comandos de artisan para generar plantillas de clases, esto debe ser siempre la primer opción.
• En lo relevante, por favor, utilizar docstrings para describir la funcion de atributos, metodos o clases, esto ayuda a poder ver rapidamente que hace el codigo que se genera.

/**
 * Funcion para calcular el area de un circulo.
 * @param float $radio Radio del circulo
 * @returns float Area dada la magnitud del radio.
 */
function areaCirculo(float $radio) {
    return 3.1416 * $radio * $radio;
}

• Entendible > Compacto. Entendible es mejor que compacto.