Podstawowe repozytorium Blockly zawiera kod wymagany do uruchamiania dowolnej aplikacji opartej na Blockly.
Co musisz wiedzieć
Oto krótki przegląd faktów o blokowych elementach, które musisz znać, aby stworzyć PR.
- Działająca gałąź jest rozwijana, a wszelkie działania PR należy tworzyć w odniesieniu do programowania.
- Musisz wypełnić szablon żądania pull wymaganymi informacjami.
- Kod musi być zgodny z opracowaną przez Google przewodnikiem po stylach TypeScriptu.
- Używaj zatwierdzeń konwencjonalnych w wiadomościach zatwierdzania i tytułów żądań pull.
- Ciągi tekstowe 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ć zwykle pisany małymi literami (tak jak w przypadku słów kluczowych w większości języków programowania).
- Zachowaj zgodność wsteczną. Jest wiele aplikacji Blockly, których nie zniszczy u wszystkich.
Wszystkie nowe pliki kodu muszą mieć prefiks Apache License w wersji 2.0:
/** * @license * Copyright <Current YYYY> Google LLC * SPDX-License-Identifier: Apache-2.0 */
Wprowadzanie i potwierdzanie zmiany
- Uruchom
npm install
, aby zainstalować zależności. - Uruchom polecenie
npm run start
, aby uruchomić serwer, na którym działa plac zabaw. Na tej stronie możesz przetestować obecny sposób działania. Więcej informacji znajdziesz na stronie playground. - Wprowadź niezbędne zmiany w kodzie.
- Jeśli serwer pozostanie uruchomiony, odśwież stronę, aby zobaczyć zmiany. W przeciwnym razie ponownie uruchom serwer i sprawdź, czy kod działa zgodnie z oczekiwaniami i nie ma żadnych błędów ani ostrzeżeń.
- Uruchom
npm run build
i upewnij się, że nie ma błędów kompilacji. - Pisanie testów automatycznych. Zwykle są to testy mokki w katalogu
tests/mocha
, ale możemy poprosić Cię o inne rodzaje testów. - Uruchom
npm run format
, aby sformatować kod i automatycznie rozwiązać niektóre problemy. - Uruchom
npm test
, aby uruchomić testy automatyczne. To także działaeslint
. - Jeśli wystąpią błędy lintowania, uruchom
npm run lint:fix
, aby rozwiązać problemy, które można automatycznie naprawić. Rozwiąż wszystkie pozostałe ostrzeżenia i błędy dotyczące lintowania. - Jeśli wszystkie testy zakończą się powodzeniem, możesz otworzyć PR dotyczący zmian w ramach programowania.