Przejdź do treści głównej

Rejestr zmian w pull requestach

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 →

Wpis w rejestrze zmian w Twoim pull requeście służy jako swego rodzaju "streszczenie" wprowadzanych modyfikacji: czy dotyczą Androida? czy to zmiany łamiące kompatybilność? czy dodajesz nową funkcję?

Dostarczenie rejestru zmian w ustandaryzowanym formacie pomaga koordynatorom wydań tworzyć notki wydawnicze. Prosimy o dołączenie rejestru zmian w opisie pull requesta. Ten opis zostanie użyty jako komunikat commitu po zatwierdzeniu pull requesta.

Format​

Wpis w rejestrze zmian ma następujący format:

## Changelog:

[Category] [Type] - Message

Pole "Kategoria" może przyjmować wartości:

  • Android - dla zmian dotyczących Androida.

  • iOS - dla zmian dotyczących iOS.

  • General - dla zmian niepasujących do innych kategorii.

  • Internal - dla zmian nieistotnych dla deweloperów korzystających z notek wydawniczych.

Pole "Typ" może przyjmować wartości:

  • Breaking - dla zmian łamiących kompatybilność.

  • Added - dla nowych funkcjonalności.

  • Changed - dla modyfikacji istniejących funkcji.

  • Deprecated - dla funkcji oznaczonych do usunięcia.

  • Removed - dla usuniętych funkcji.

  • Fixed - dla naprawionych błędów.

  • Security - w przypadku luk bezpieczeństwa.

Pole "Wiadomość" powinno opisywać "co i dlaczego" na poziomie funkcjonalności. Użyj go, by zwięźle poinformować użytkowników React Native o istotnych zmianach.

Więcej szczegółów znajdziesz w artykułach: Jak stworzyć dobry rejestr zmian? oraz Po co prowadzić rejestr zmian?

Przykłady​

  • [General] [Added] - Add snapToOffsets prop to ScrollView component

  • [General] [Fixed] - Fix various issues in snapToInterval on ScrollView component

  • [iOS] [Fixed] - Fix crash in RCTImagePicker

Częste pytania​

Co jeśli mój pull request zawiera zmiany dla Androida i JavaScriptu?​

Użyj kategorii Android.

Co jeśli mój pull request zawiera zmiany dla Androida i iOS?​

Użyj kategorii General, jeśli zmiana jest wprowadzana w jednym pull requeście.

Co jeśli mój pull request zawiera zmiany dla Androida, iOS i JavaScriptu?​

Użyj kategorii General, jeśli zmiana jest wprowadzana w jednym pull requeście.

A co jeśli...?​

Każdy wpis w rejestrze zmian jest lepszy niż żaden. Jeśli nie masz pewności co do wyboru kategorii, użyj pola "wiadomość", by zwięźle opisać swoją zmianę.

Te wpisy są wykorzystywane przez skrypt @rnx-kit/rn-changelog-generator do stworzenia wersji roboczej, która jest następnie edytowana przez koordynatora wydania.

Twoje notatki posłużą do umieszczenia zmian w odpowiedniej sekcji ostatecznych notek wydawniczych.