Repozytorium podstawowe Blockly zawiera kod potrzebny do uruchamiania dowolnej aplikacji opartej na Blockly.
Co musisz wiedzieć
Oto krótki przegląd informacji o Blockly Core, 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 zatwierdzeniu i tytułach prośby o włączenie 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. - 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 wiele 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
- Uruchom
npm install
, aby zainstalować zależności. - Uruchom
npm run start
, aby uruchomić serwer z platformą Playground. Na tej stronie możesz przetestować obecne działanie. Więcej informacji znajdziesz na stronie playground. - Wprowadź w kodzie wszelkie niezbędne zmiany.
- 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 i czy w konsoli nie ma błędów ani ostrzeżeń.
- Uruchom
npm run build
i sprawdź, czy nie ma błędów kompilacji. - pisać testy automatyczne, Zwykle są to testy mocha w katalogu
tests/mocha
, ale możemy poprosić Cię o inne testy. - Uruchom
npm run format
, aby sformatować kod i automatycznie naprawić niektóre problemy z lintem. - Uruchom automatyczne testy
npm test
. To polecenie uruchamia teżeslint
. - 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 i błędy lint. - Jeśli wszystkie testy się powiodą, możesz otworzyć PR w gałęzi develop, w której znajdują się zmiany.