Checklist para crear tu paquete PHP (composer)

Es un buen recurso para revisar a la hora de crear un paquete PHP que quieras distribuir por composer, una lista de puntos a tener en cuenta que deberías cumplir antes de publicarlo:



Cito algunos puntos:
  1. Elige un nombre sabiamente: revisa antes que no exista el nombre en el listado de paquetes, no uses tu nombre o apellido para usarlo en el nombre. 
  2.  Autoloader friendly: usa el estándar PSR-4 para hacer funcionar el autoloader en tu paquete, y coloca el código en la carpeta /src/
  3. Distribuye via Composer: si vas a hace un paquete, y quieres que sea público y lo puedan usar en otros proyectos, utiliza Composer.
  4. Sé Framework Agnostico: no limites tu proyecto / paquete a un solo framework.
  5. Sigue un estilo al codificar: utiliza estándares como PSR-2, donde especifican un estilo de codificación aprobado por la PHP-FIG (The PHP Framework Interop Group).
La lista completa sigue, hace referencia a que escribas test unitarios, no te olvides de la documentación en el código con DocBlock, agrega documentación extra, también un changelog, incluir un tipo de licencia, etc.


No hay comentarios.:

Entradas populares