Documentación · Documentación para desarrolladores
Configuración del desarrollo local
Esta página describe la estructura segura para el ámbito público de un entorno de desarrollo local para el plugin. Los valores exactos de las constantes, las rutas de archivos, los scripts de ayuda internos y la configuración de servicios gestionados utilizados por el propio equipo de desarrollo de AD Promotion no se publican aquí.
Cuándo utilizar este documento
Utilice este documento cuando:
- Esté contribuyendo con código, plantillas o documentación al plugin desde un fork.
- Necesite reproducir un error localmente antes de reportarlo o solucionarlo.
- Quiera evaluar el comportamiento del plugin en una instalación controlada de WordPress.
Los usuarios finales que instalen el plugin en un sitio de producción deben seguir en su lugar la guía de instalación del manual del usuario.
Requisitos generales
- Git para clonar su fork del repositorio.
- PHP en la versión mínima declarada en la cabecera del plugin.
- Composer para instalar las dependencias de desarrollo (solo para el framework de pruebas; el plugin no tiene dependencias de Composer en tiempo de ejecución).
- Una instalación local de WordPress en la versión mínima de WordPress declarada en la cabecera del plugin. Cualquier herramienta estándar de desarrollo local funciona (Local, DDEV, Lando, wp-env, Docker, MAMP, LAMP/LEMP nativo, etc.).
Flujo de trabajo típico
- Clone su fork del repositorio.
- Coloque (o cree un enlace simbólico de) la carpeta del plugin dentro de
wp-content/plugins/de una instalación local de WordPress que cumpla con las versiones mínimas documentadas del plugin. - Active el plugin desde
wp-admin. - Instale las dependencias de desarrollo con Composer si tiene la intención de ejecutar la suite de pruebas del proyecto.
- Ejecute la suite de pruebas desde la raíz del proyecto siguiendo la Guía de pruebas.
- Realice sus cambios siguiendo los Estándares de codificación y las Directrices de contribución.
Notas de funcionamiento
- Nunca suba credenciales o secretos al repositorio. Configure las credenciales de la API, los tokens de automatización o los secretos de webhook a través de la interfaz de administración del plugin en su sitio local, no a través de archivos incluidos en el control de versiones. No coloque credenciales en fragmentos de
wp-config.phpque estén bajo el control de código fuente. - Servicios gestionados. Algunas características del plugin dependen de servicios gestionados por AD Promotion que se aprovisionan para los sitios de los clientes. Para el desarrollo local de esas características, utilice sus propias credenciales de prueba personales configuradas a través de la interfaz de administración; la configuración gestionada de AD Promotion no se distribuye.
- Diagnósticos detallados. Cuando necesite más detalles de diagnóstico a nivel local, active el registro detallado (verbose logging) desde la interfaz de administración del plugin en lugar de depender de las rutas de registro internas.
Aviso de documentación pública. Esta página proporciona únicamente una descripción general de la integración a alto nivel. Los detalles de implementación interna, las API privadas, los aspectos internos del almacenamiento y la infraestructura de lanzamiento sensible a la seguridad se mantienen por separado y no forman parte de la documentación pública.