Jak współtworzyć projekt.

Learn DXPR BuilderExtendTooling

Rozwój kreatora DXPR odbywa się na GitHubie w github.com/dxpr/dxpr_builder. Wszystkie wkłady podążają za przebiegiem opisanym w CONTRIBUTING.md repozytorium.

Przebieg pracy z gitem

  1. Każdy pull request musi być powiązany ze zgłoszeniem GitHub
  2. Konwencja nazewnictwa gałęzi: person/target-branch/#issue-description (np. jur/3.x/#42-fix-carousel-autoplay)
  3. Pisz atomowe commity według przewodnika stylu gita alphagov
  4. Pull requesty muszą zawierać krótki opis rozwiązania
  5. Trzymaj zmiany w zakresie zgłoszenia: bez niepowiązanego formatowania i refaktoryzacji

Właściciel kodu

@jjroelofs pełni rolę właściciela kodu. Żaden pull request nie może zostać scalony bez recenzji właściciela kodu.

Standardy kodowania

  • PHP: standardy kodowania Drupala
  • JavaScript: tylko ES6+ (bez var, bez jQuery w nowym kodzie). Przestrzegaj standardów kodowania JavaScript Airbnb z wyjątkami projektu
  • CSS: przestrzegaj systemu projektowego dla właściwości własnych i nazewnictwa tokenów
  • Zmiana metody showed elementu musi zawierać zaktualizowany dxpr_frontend.js. Wygeneruj go z pełnego wyniku wypisywanego przez edytor do konsoli przeglądarki po kliknięciu przycisku zapisu kontenera.
  • Nowe funkcje wymagają pokrycia QA Analytics.

Uruchom npm install raz po sklonowaniu. Instaluje hook pre-commit Husky, który lintuje pliki staged; zobacz testowanie.

Uruchamianie testów E2E

Testy wyzwalane są poleceniami slash w komentarzach PR:

Polecenie Opis
/e2e Uruchom pełne pakiety edytora BS5 i anonimowe
/e2e groups=group-name Uruchom wybrane grupy testów
/e2e tests=ClassName Uruchom wybrane klasy testów
/e2e-bs3 Uruchom pakiet edytora BS3
/e2eV2 Uruchom pakiety BS5 na stosie DXPR CMS
/e2e maven_ref=branch Testuj z gałęzią dxpr_maven o własnej nazwie

Gdy zmiana kreatora wymaga zmiany testu, inżynier QA aktualizuje dxpr_maven na gałęzi, a ty uruchamiasz /e2e maven_ref=<branch> na swoim pull requeście. Pull request kreatora scala się najpierw, potem ten dxpr_maven.

Przed poproszeniem o recenzję

  1. Zaimplementuj zmianę
  2. Starannie przetestuj
  3. Wykonaj rundę porządków/refaktoryzacji
  4. Przetestuj ponownie, aby potwierdzić, że nic się nie zepsuło
  5. Scommituj i wypchnij z czystą historią gita
  6. Sprawdź, czy kontrole lintera przechodzą
  7. Skomentuj /e2e w PR, aby uruchomić testy regresji
  8. Poproś o recenzję, gdy wszystkie kontrole przejdą