Mitwirken.

DXPR Builder lernenErweiternWerkzeuge

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

Git-Workflow

  1. Jeder Pull-Request muss mit einem GitHub-Issue verlinkt sein
  2. Branch-Benennung: person/target-branch/#issue-description (z. B. jur/3.x/#42-fix-carousel-autoplay)
  3. Atomare Commits schreiben, nach dem alphagov-Git-Styleguide
  4. Pull-Requests müssen eine kurze Beschreibung der Lösung enthalten
  5. Änderungen im Rahmen des Issues halten: keine artfremde Formatierung oder Refaktorierung

Code-Owner

@jjroelofs ist Code-Owner. Keine Pull-Requests werden ohne ein Review dieser Person gemergt.

Coding-Standards

  • PHP: Drupal-Coding-Standards
  • JavaScript: nur ES6+ (kein var, kein jQuery in neuem Code). Den Airbnb-JavaScript-Coding-Standards mit Projektausnahmen folgen
  • CSS: dem Design-System für eigene 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 vollen Ausgabe, die der Editor in die Browser-Konsole druckt, wenn Sie auf die Speichern-Schaltfläche eines Containers klicken.
  • Neue Features brauchen QA-Analytics-Abdeckung.

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

E2E-Tests ausführen

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

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

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

Vor der Review-Anfrage

  1. Änderung implementieren
  2. Sorgfältig testen
  3. Aufräum-/Refaktorierungsrunde drehen
  4. Erneut testen, um zu bestätigen, dass nichts gebrochen ist
  5. Mit sauberer Git-Historie committen und pushen
  6. Prüfen, dass Linter-Prüfungen bestehen
  7. Kommentieren Sie /e2e auf dem PR, um Regressionstests zu starten
  8. Review anfragen, wenn alle Prüfungen bestehen