Współtworzenie rdzenia

Główne repozytorium Blockly zawiera kod potrzebny do uruchomienia dowolnej aplikacji opartej na Blockly.

Co musisz wiedzieć

Oto krótkie omówienie faktów dotyczących podstawowej biblioteki Blockly, które musisz znać, aby utworzyć żądanie pull request.

  • Gałęzią roboczą jest main i wszystkie żądania scalenia powinny być kierowane do gałęzi main.
  • Musisz wypełnić szablon prośby o scalenie, podając wymagane informacje.
  • Kod musi być zgodny z przewodnikiem po stylu TypeScript Google.
  • W komunikatach o zatwierdzeniu i tytułach żądań scalenia używaj konwencjonalnych zatwierdzeń.
  • Ciągi tekstowe widoczne dla użytkownika muszą znajdować się w pliku /msg/messages.js, aby można było je przetłumaczyć. Mniej niż 6% ludzi na świecie posługuje się językiem angielskim jako ojczystym.
  • Tekst w blokach powinien być zapisywany małymi literami (podobnie jak słowa kluczowe w większości języków programowania).
  • zachować zgodność wsteczną, Istnieje wiele aplikacji Blockly, nie psuj ich wszystkim.

  • 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, aby zainstalować zależności.
  2. Uruchom npm run start, aby uruchomić serwer z placem zabaw. Na tej stronie możesz przetestować dotychczasowe działanie. Więcej informacji znajdziesz na stronie playground.
  3. Wprowadź niezbędne zmiany w kodzie.
  4. Jeśli serwer jest nadal uruchomiony, odśwież stronę, aby zobaczyć zmiany. W przeciwnym razie uruchom ponownie serwer i sprawdź, czy kod 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. pisać testy automatyczne, Zwykle są to testy Mocha w katalogu tests/mocha, ale możemy poprosić Cię o inne rodzaje testów.
  7. Uruchom npm run format, aby sformatować kod i automatycznie rozwiązać niektóre problemy z lintem.
  8. Aby uruchomić testy automatyczne, kliknij npm test. Spowoduje to również uruchomienie eslint.
  9. Jeśli występują błędy lint, uruchom polecenie npm run lint:fix, aby rozwiązać problemy, które można naprawić automatycznie. Usuń pozostałe ostrzeżenia lub błędy.
  10. Jeśli wszystkie testy zakończą się powodzeniem, możesz otworzyć żądanie scalenia z gałęzią main, zawierające Twoje zmiany.