Przejdź do treści głównej

Jak otworzyć pull request

Nieoficjalne Tłumaczenie Beta

Ta strona została przetłumaczona przez PageTurner AI (beta). Nie jest oficjalnie zatwierdzona przez projekt. Znalazłeś błąd? Zgłoś problem →

Te instrukcje krok po kroku pomogą ci przygotować środowisko do współtworzenia głównego repozytorium React Native i stworzenia twojego pierwszego pull requesta.

Prolog: Przygotowania​

Do budowania i rozwijania React Native potrzebujesz kilku narzędzi i zależności. Są one opisane w przewodniku Konfiguracja środowiska w sekcji "Budowanie projektów z natywnym kodem".

Aby zaakceptować twój pull request, musisz przesłać Umowę Licencyjną Współtwórcy (CLA). Wystarczy to zrobić raz dla wszystkich projektów open source Meta. To zajmuje minutę - możesz to zrobić podczas instalacji zależności.

Rozdział I: Witaj w open source​

1. Zainstaluj git​

Kod źródłowy React Native jest hostowany na GitHubie. Możesz korzystać z systemu kontroli wersji git poprzez program wiersza poleceń git. Zalecamy postępować zgodnie z instrukcjami GitHub podczas konfiguracji gita na twoim komputerze.

2. Pobierz kod źródłowy​

Choć kod React Native możesz przeglądać na GitHub, zalecamy skonfigurowanie forka na lokalnej maszynie.

  1. Przejdź na https://github.com/facebook/react-native.

  2. Kliknij przycisk "Fork" w prawym górnym rogu.

  3. Po wyświetleniu pytania wybierz swoją nazwę użytkownika jako miejsce docelowe forka.

Twój fork React Native będzie dostępny na GitHubie pod adresem https://github.com/your_username/react-native. Następnie pobierzesz kopię kodu źródłowego na lokalną maszynę. Otwórz terminal i wprowadź następujące polecenia:

bash
git clone https://github.com/facebook/react-native.git
cd react-native
git remote add fork https://github.com/your_username/react-native.git
uwaga

Jeśli powyższe wydaje ci się nowe, nie martw się. Terminal możesz otworzyć przez aplikację Terminal w macOS i Linuxie lub PowerShell w Windows.

Nowy katalog react-native zostanie utworzony z zawartością głównego repozytorium React Native. Ten katalog jest klonem repozytorium git React Native i zawiera dwa zdalne repozytoria:

3. Utwórz gałąź​

Zalecamy utworzenie nowej gałęzi w twoim forku, aby śledzić wprowadzane zmiany:

bash
git checkout -b my_feature_branch --track origin/main

Rozdział II: Wprowadzanie zmian​

1. Zainstaluj zależności​

React Native to monorepo JavaScript zarządzane przez Yarn Workspaces (Yarn Classic).

Wykonaj instalację na poziomie projektu:

sh
yarn

Musisz także jednorazowo zbudować pakiet react-native-codegen:

sh
yarn --cwd packages/react-native-codegen build

2. Wprowadź zmiany w kodzie​

Możesz teraz otworzyć projekt w wybranym edytorze kodu. Visual Studio Code jest popularny wśród developerów JavaScript i zalecany przy wprowadzaniu ogólnych zmian w React Native.

Konfiguracje projektów w IDE:

  • VS Code: Otwórz plik react-native.code-workspace. Powinien otworzyć się z rekomendacjami rozszerzeń i poprawnie skonfigurowaną usługą języka Flow oraz innymi ustawieniami edytora.

  • Android Studio: Otwórz główny folder repozytorium (zawierający katalog konfiguracyjny .idea).

  • Xcode: Otwórz packages/rn-tester/RNTesterPods.xcworkspace.

3. Przetestuj swoje zmiany​

Pakiet rn-tester może być używany do uruchamiania i weryfikacji wprowadzanych zmian. Więcej informacji znajdziesz w dokumentacji RNTester.

4. Przetestuj swoje zmiany​

Upewnij się, że zmiany są poprawne i nie powodują błędów w testach. Więcej informacji znajdziesz w sekcji Uruchamianie i pisanie testów.

5. Sprawdź swój kod linterem​

Rozumiemy, że przyzwyczajenie się do konwencji stylistycznych każdego języka używanego w głównym repozytorium React Native może zająć trochę czasu. Programiści nie powinni martwić się drobnymi niuansami, dlatego tam gdzie to możliwe używamy narzędzi automatyzujących proces dopasowywania kodu do konwencji.

Przykładowo, używamy Prettiera do formatowania kodu JavaScript. Oszczędza to twój czas i energię, ponieważ Prettier może automatycznie poprawiać problemy z formatowaniem poprzez integracje z edytorem lub ręczne uruchomienie polecenia yarn run prettier.

Używamy również lintera do wykrywania potencjalnych problemów stylistycznych w kodzie. Możesz sprawdzić styl swojego kodu uruchamiając yarn run lint.

Więcej o konwencjach kodowania dowiesz się z przewodnika po stylu kodowania.

6. Przejrzyj swoje zmiany​

Wiele popularnych edytorów oferuje integrację z kontrolą wersji. Możesz także użyć poleceń git status i git diff w linii poleceń, aby śledzić wprowadzone zmiany.

Rozdział III: Proponowanie zmian​

1. Wykonaj commit swoich zmian​

Dodaj zmiany do kontroli wersji za pomocą git:

bash
git add <filename>
git commit -m <message>

Jako wiadomość commita możesz użyć krótkiego, opisowego zdania.

uwaga

Martwisz się o jakość wiadomości commitów? Spokojnie! Po scaleniu twojego pull requesta wszystkie commity zostaną złączone w jeden. To opis pull requesta zostanie użyty jako wiadomość dla tego połączonego commita.

Ten przewodnik zawiera wystarczające informacje na początek twojego wkładu. GitHub oferuje dodatkowe zasoby dla początkujących z gitem:

2. Wyślij zmiany do GitHub (push)​

Po zatwierdzeniu zmian w kontroli wersji możesz przesłać je do GitHub.

bash
git push fork <my_feature_branch>

Jeśli wszystko przebiegło pomyślnie, zobaczysz komunikat zachęcający do otwarcia pull requesta:

remote:
remote: Create a pull request for 'your_feature_branch' on GitHub by visiting:
remote:      https://github.com/your_username/react-native/pull/new/your_feature_branch
remote:

Odwiedź podany adres URL, aby przejść do następnego kroku.

3. Utwórz pull request​

Już prawie gotowe! Następnie wypełnij formularz pull requesta. Użyj opisowego, ale zwięzłego tytułu. Upewnij się, że wypełniasz wszystkie pola z domyślnego szablonu:

  • Podsumowanie: Opisz motywację wysłania tego pull requesta. Co naprawiasz?

  • Changelog: Pomóż opiekunom wydań tworzyć notki wydawnicze, podając krótki opis zmian w przypadku akceptacji pull requesta.

  • Plan testów: Poinformuj recenzentów o sposobie testowania zmian. Czy uwzględniłeś przypadki brzegowe? Jakie kroki podjąłeś, aby potwierdzić efekt zmian? Więcej w artykule Czym jest plan testów?.

4. Przejrzyj i uwzględnij uwagi​

Śledź na bieżąco wszystkie komentarze i opinie z recenzji zamieszczone w twoim pull requeście na GitHubie. Opiekunowie repozytorium zrobią wszystko, by przekazać konstruktywne i praktyczne wskazówki, które pomogą przygotować twoje zmiany do włączenia do głównego repozytorium React Native.