Cómo contribuir.

Aprende DXPR BuilderExtenderHerramientas

El desarrollo de DXPR Builder ocurre en GitHub en github.com/dxpr/dxpr_builder. Todas las contribuciones siguen el flujo descrito en el CONTRIBUTING.md del repositorio.

Flujo Git

  1. Cada pull request debe estar vinculado a un issue de GitHub
  2. Convención de nombres de rama: person/target-branch/#issue-description (p. ej. jur/3.x/#42-fix-carousel-autoplay)
  3. Escribe commits atómicos siguiendo la guía de estilo Git de alphagov
  4. Los pull requests deben contener una descripción corta de la solución
  5. Mantén los cambios dentro del alcance del issue: sin formato ni refactorización no relacionados

Propiedad del código

@jjroelofs es la persona propietaria del código. Ningún pull request puede fusionarse sin su revisión.

Estándares de código

  • PHP: estándares de código de Drupal
  • JavaScript: solo ES6+ (sin var, sin jQuery en código nuevo). Sigue los estándares de código JavaScript de Airbnb con excepciones del proyecto
  • CSS: sigue el sistema de diseño para propiedades personalizadas y nombres de tokens
  • Un cambio en el método showed de un elemento debe incluir el dxpr_frontend.js actualizado. Genéralo desde la salida completa que el editor imprime en la consola del navegador cuando haces clic en el botón de guardado de un contenedor.
  • Las funciones nuevas necesitan cobertura de QA Analytics.

Ejecuta npm install una vez tras clonar. Instala el hook pre-commit de Husky, que revisa tus archivos en staging; consulta Pruebas.

Ejecución de pruebas E2E

Las pruebas se activan con comandos de barra en comentarios de PR:

Comando Descripción
/e2e Ejecuta las suites completas de editor BS5 y anónimas
/e2e groups=group-name Ejecuta grupos de pruebas específicos
/e2e tests=ClassName Ejecuta clases de pruebas específicas
/e2e-bs3 Ejecuta la suite de editor BS3
/e2eV2 Ejecuta las suites BS5 en la pila DXPR CMS
/e2e maven_ref=branch Prueba con una rama dxpr_maven personalizada

Cuando un cambio del constructor necesita un cambio de pruebas, la persona de QA actualiza dxpr_maven en una rama, y ejecutas /e2e maven_ref=<branch> en tu pull request. El pull request del constructor se fusiona primero, y luego el de dxpr_maven.

Antes de pedir revisión

  1. Implementa el cambio
  2. Prueba con cuidado
  3. Haz una ronda de limpieza/refactorización
  4. Vuelve a probar para confirmar que nada se rompió
  5. Haz commit y push con un historial git limpio
  6. Comprueba que pasan las revisiones del linter
  7. Comenta /e2e en el PR para ejecutar pruebas de regresión
  8. Pide revisión cuando pasan todas las comprobaciones