Mitwirken.

Learn DXPR BuilderManage the siteVariaties testen

Die Entwicklung von DXPR Builder findet auf GitHub statt, unter github.com/dxpr/dxpr_builder. Alle Beiträge folgen dem Workflow, der im CONTRIBUTING.md des Repositorys beschrieben ist.

Git-Workflow

  1. Jeder Pull Request muss mit einem GitHub-Issue verknüpft sein
  2. Branch-Benennung: person/target-branch/#issue-description (z. B. jur/3.x/#42-fix-carousel-autoplay)
  3. Schreiben Sie atomare Commits im Stil des alphagov-Git-Styleguides
  4. Pull Requests müssen eine kurze Beschreibung der Lösung enthalten
  5. Änderungen im Rahmen des Issues halten: keine unzugehörige Formatierung und kein unzugehöriges Refactoring

Code-Owner

@jjroelofs ist der Code-Owner. Ohne deren Review kann kein Pull Request gemergt werden.

Coding-Standards

  • PHP: Drupal-Coding-Standards
  • JavaScript: nur ES6+ (kein var, kein jQuery in neuem Code). Den Airbnb-JavaScript-Coding-Standards mit den Ausnahmen des Projekts folgen
  • CSS: dem Design System für Custom Properties und Token-Benennung folgen
  • Eine Änderung an der showed-Methode eines Elements muss das aktualisierte dxpr_frontend.js enthalten. Erzeugen Sie es aus der vollständigen Ausgabe, die der Editor in die Browser-Konsole schreibt, wenn Sie auf den Speichern-Button eines Containers klicken.
  • Neue Funktionen brauchen QA-Analytics-Abdeckung.

Führen Sie nach dem Klonen einmal npm install aus. Damit wird der Husky-Pre-Commit-Hook installiert, der Ihre gestagten Dateien lintet; siehe Testen.

E2E-Tests ausführen

Tests werden per Slash-Befehl in PR-Kommentaren ausgelöst:

Befehl Beschreibung
/e2e Die kompletten BS5-Editor- und Anonymous-Suiten ausführen
/e2e groups=group-name Bestimmte Testgruppen ausführen
/e2e tests=ClassName Bestimmte Testklassen ausführen
/e2e-bs3 Die BS3-Editor-Suite ausführen
/e2eV2 Die BS5-Suiten auf dem DXPR CMS-Stack ausführen
/e2e maven_ref=branch Mit einem eigenen dxpr_maven-Branch testen

Wenn eine Builder-Änderung eine Teständerung braucht, aktualisiert der QA-Engineer dxpr_maven auf einem Branch, und Sie führen /e2e maven_ref=<branch> auf Ihrem Pull Request aus. Der Builder-Pull-Request wird zuerst gemergt, dann der dxpr_maven-Pull-Request.

Vor der Review-Anfrage

  1. Die Änderung umsetzen
  2. Sorgfältig testen
  3. Eine Cleanup-/Refactoring-Runde einlegen
  4. Erneut testen, um sicherzugehen, dass nichts kaputt ist
  5. Mit sauberer Git-Historie committen und pushen
  6. Prüfen, dass die Linter-Checks bestehen
  7. Kommentieren Sie /e2e im PR, um Regressionstests zu starten
  8. Review anfordern, sobald alle Checks bestehen