Skip to content

Reglas de programación

Manuela Herrera-López edited this page Mar 19, 2022 · 5 revisions

Controladores

  • Nunca se debe hacer echo en un controlador.
  • El acceso a las variables debe ser a través de los getters y setters.
  • No poner paths (ni relativos ni absolutos) en la redirección o muestra de las vistas.
  • Si hay un método que elimine valores de la base de datos, utilice al final una redirección (nunca desplegar una vista).
  • Las funciones que tengan porciones de código que no sean obvias, deben tener un comentario asociado diciendo qué hace.
  • Las funciones deben ser llamadas en la medida de lo posible como una acción.

Vistas

  • Por cada controlador debe haber una carpeta en resources/views con el mismo nombre y allí se deben guardar los blades asociados.
  • No poner código php en las vistas (no usar el tag <?php de blade).
  • El acceso a las variables debe ser a través de los getters y setters.
  • Todas las vistas deben extender de un layout y utilizar @section para modificar los bloques de código que sean necesarios.
  • Al enrutar en las vistas, usar los nombres que se le dieron en el archivo web.php. Lo anterior quiere decir que no debe quemar la dirección de la ruta en el código.

Modelo

  • En las primeras líneas del modelo decir cuáles son los campos de la tabla como un comentario.
  • Si no se va a usar factory, borrar lo relacionado a esta.
  • Las validaciones de los datos deben ir en el modelo.
  • Por cada campo de la base de datos debe haber un set y un get.
  • Sólo utilizar eloquent para el manejo de las vistas (no usar otro, y no mezclar).

Rutas

  • Las rutas deben estar asociadas a un controlador.
  • Lo único que se debe hacer es llamar métodos del controlador (no lógica).

Notas

Para trabajar en el proyecto, nunca se debe hacer push al main, se debe crear una rama que se nombre como -, en donde tipo puede ser fix (para arreglar un problema) o dev (para agregar una nueva funcionalidad), y funcionalidad será el tema que se está tratando. Luego de tener los cambios en la rama, hacer un pull request y asociar al arquitecto como reviewer.

Clone this wiki locally