Współtworzenie fragmentów

Przykłady Blockly zawierają dodatkowe treści związane z Blockly, które nie są częścią głównego repozytorium, w tym wtyczki, codelaby i przykładowy kod. Więcej informacji o każdym z tych elementów znajdziesz na stronie Struktura repozytorium.

Co musisz wiedzieć

Oto krótkie omówienie faktów dotyczących repozytorium blockly-samples, które musisz znać, aby utworzyć żądanie scalenia.

  • Gałęzią roboczą jest main i wszystkie żądania scalenia powinny być kierowane do tej gałęzi.
  • Uruchom npm install w katalogu głównym blockly-samples,a nie na poziomie poszczególnych wtyczek. Blockly-samples to monorepo, co oznacza, że zawiera wiele pakietów w tym samym repozytorium, a instalacja na poziomie głównym jest częścią przepływu pracy związanego z zarządzaniem monorepo za pomocą Lerny.
  • Kod musi być zgodny z przewodnikiem po stylu JavaScript lub przewodnikiem po stylu TypeScript w zależności od używanego języka.
  • W komunikatach o zatwierdzeniu i tytułach żądań scalenia używaj konwencjonalnych zatwierdzeń.

  • Wszystkie nowe pliki kodu muszą mieć prefiks w postaci licencji Apache w wersji 2.0:

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

Wprowadzanie i weryfikowanie zmian

  1. Uruchom npm install w katalogu głównym blockly-samples, aby zainstalować zależności.
  2. Uruchom npm run start w katalogu wtyczki, aby skompilować i uruchomić serwer z testową stroną wtyczki. Na tej stronie możesz sprawdzić dotychczasowe działanie wtyczki. Jeśli dodajesz nową wtyczkę, musisz utworzyć przydatną stronę testową, aby inni mogli zobaczyć, co robi Twoja wtyczka. Więcej informacji znajdziesz na stronie playground.
  3. Wprowadź niezbędne zmiany w kodzie wtyczki.
  4. Jeśli serwer jest nadal uruchomiony, zmiany zostaną wczytane automatycznie. W przeciwnym razie uruchom ponownie serwer i sprawdź, czy wtyczka działa zgodnie z oczekiwaniami oraz czy w konsoli nie ma błędów ani ostrzeżeń.
  5. Uruchom npm run build i upewnij się, że nie ma błędów kompilacji.
  6. Napisz automatyczne testy Mocha w katalogu test/.
  7. Aby uruchomić testy automatyczne, kliknij npm run test.
  8. Uruchom npm run lint:fix, aby naprawić błędy lint. Usuń pozostałe ostrzeżenia lub błędy.
  9. Uruchom npm run format, aby uruchomić automatyczny formater.
  10. Jeśli wszystkie testy zakończą się powodzeniem, możesz otworzyć żądanie scalenia z gałęzią main, zawierające Twoje zmiany.