Przekaż darowiznę

Blockly Samples zawiera dodatkowe treści związane z Blockly, które nie są częścią głównego repozytorium, w tym wtyczki, Codelabs i przykładowy kod. Więcej informacji o każdej z nich znajdziesz na stronie struktury repozytorium.

Co musisz wiedzieć

Oto krótkie omówienie faktów na temat blokowych przykładów, które warto znać, by tworzyć PR.

  • Gałąź robocza to nadrzędna, a wszystkie żądania PR powinny być kierowane do mastera.
  • Uruchom npm install na poziomie głównym w blockly-samples, a nie na poziomie poszczególnych wtyczek. Blockly-samples to repozytorium mono, co oznacza, że zawiera ono wiele pakietów w tym samym repozytorium. Instalowanie na poziomie katalogu głównego jest częścią procesu zarządzania repozytorium mono za pomocą Lerna.
  • Kod musi być zgodny ze Style Guidem JavaScript lub Style Guidem TypeScript Google, w zależności od używanego języka.
  • W wiadomościach o zatwierdzeniu i tytułach prośby o włączenie używaj tradycyjnych zatwierdzeń.

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

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

Wprowadź i zweryfikuj zmianę

  1. Uruchom npm install na poziomie 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. Możesz użyć tej strony, aby sprawdzić obecne działanie wtyczki. Jeśli dodajesz nową wtyczkę, musisz utworzyć tę stronę testową, aby inni użytkownicy mogli sprawdzić, do czego służy Twoja wtyczka. Więcej informacji znajdziesz na stronie playground.
  3. Wprowadź wszelkie niezbędne zmiany w kodzie wtyczki.
  4. Jeśli serwer jest uruchomiony, zmiany zostaną załadowane automatycznie. W przeciwnym razie uruchom ponownie serwer i sprawdź, czy wtyczka działa zgodnie z oczekiwaniami i czy w konsoli nie ma błędów ani ostrzeżeń.
  5. Uruchom npm run build i sprawdź, czy nie ma błędów kompilacji.
  6. Pisz automatyczne testy mokki w katalogu test/.
  7. Aby przeprowadzić testy zautomatyzowane, kliknij npm run test.
  8. Uruchom npm run lint:fix, aby naprawić błędy lint. Usuń pozostałe ostrzeżenia i błędy.
  9. Uruchom npm run format, aby uruchomić automatyczny formatowanie.
  10. Jeśli wszystkie testy się powiodą, możesz otworzyć PR w gałęzi master z wprowadzonymi zmianami.