Współtworzenie rdzenia

Repozytorium podstawowe Blockly zawiera kod potrzebny do uruchamiania dowolnej aplikacji opartej na Blockly.

Co musisz wiedzieć

Oto krótkie omówienie faktów dotyczących rdzenia Blockly, które musisz znać, aby utworzyć PR.

  • Gałąź robocza to develop, a wszystkie PR powinny być tworzone na podstawie gałęzi develop.
  • Musisz wypełnić szablon prośby o przeniesienie danych, podając wymagane informacje.
  • Kod musi być zgodny ze Style Guide TypeScript Google.
  • W wiadomościach o zatwierdzeniach i tytułach prośby o przechwycenie używaj tradycyjnych zatwierdzeń.
  • Teksty widoczne dla użytkownika muszą znajdować się w pliku /msg/messages.js, aby można je było przetłumaczyć. Mniej niż 6% ludzi na świecie mówi po angielsku jako języku ojczystym.
  • Tekst w blokach powinien być zazwyczaj zapisywany małymi literami (tak jak słowa kluczowe w większości języków programowania).
  • Zachowanie zgodności wstecznej. Istnieje dużo aplikacji Blockly, więc nie łam innych.

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

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

Wprowadzanie i weryfikowanie zmiany

  1. Uruchom npm install, aby zainstalować zależności.
  2. Uruchom npm run start, aby uruchomić serwer z Playground. Na tej stronie możesz przetestować obecne działanie. Więcej informacji znajdziesz na stronie playground.
  3. Wprowadź w kodzie wszelkie niezbędne zmiany.
  4. Jeśli serwer jest uruchomiony, odśwież stronę, aby zobaczyć zmiany. W przeciwnym razie uruchom ponownie serwer i sprawdź, czy kod działa zgodnie z oczekiwaniami i 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. pisać testy automatyczne, Zwykle są to testy mocha w katalogu tests/mocha, ale możemy poprosić Cię o inne testy.
  7. Uruchom npm run format, aby sformatować kod i automatycznie naprawić niektóre problemy z lintem.
  8. Aby przeprowadzić testy zautomatyzowane, kliknij npm test. Spowoduje to też uruchomienie eslint.
  9. Jeśli występują błędy lint, uruchom npm run lint:fix, aby naprawić błędy, które można naprawić automatycznie. Usuń pozostałe ostrzeżenia lub błędy lint.
  10. Jeśli wszystkie testy się powiodą, możesz otworzyć PR w gałęzi develop, w której znajdują się zmiany.