Convenciones¶
Código¶
- Sin docblocks: no usar
/** */. Tipos nativos, type hints y nombres autoexplicativos. - Sin JSDoc salvo información que TypeScript no pueda expresar (aplica al frontend).
- Comentarios: solo
//breves, en inglés, cuando el código no se explique solo y nunca dentro de un método. - Orden alfabético: métodos y propiedades (case-insensitive), constructores primero.
- PSR-12 con
laravel/pint.
La referencia completa está en el hub: Convenciones de código.
Idioma¶
| Artefacto | Idioma |
|---|---|
| Documentación, README, este sitio | Español |
| Código, nombres, commits, PRs | Inglés |
| CHANGELOG y release notes | Inglés |
| Mensajes de UI | Inglés como fuente, traducidos con __() |
Documentación¶
- Se actualiza en el mismo PR que el cambio.
- Si cambia un resource/page/action/service, se actualiza la referencia.
- Si cambia una variable de entorno, se actualiza
.env.exampley el hub. - Si cambia un flujo de negocio, se actualiza su página de funcionalidad.
- Si cambia deploy o infraestructura, se actualiza operación.
Checks¶
vendor/bin/pint
php scripts/docs-inventory.php --check
php scripts/docs-coverage.php
Git¶
- Ramas:
feature/* -> testing -> staging -> master. - Commits descriptivos, en inglés.
- No commitear secretos ni
.env.