Ćwiczenie — tworzenie pierwszego żądania ściągnięcia

  • 6 minut

Wiesz już, jak utworzyć żądanie ściągnięcia, gdy są dostępne odpowiednie wskazówki — w postaci szablonu żądania ściągnięcia lub w pliku CONTRIBUTING. Ale co zrobić, jeśli w projekcie nie zamieszczono wskazówek ani dokumentacji dotyczącej konwencji?

Opisywanie zmian

Aby napisać dobry komunikat dotyczący zatwierdzenia, a następnie żądanie ściągnięcia, postępuj zgodnie z następującymi wskazówkami:

  • Wiersz tematu komunikatu zatwierdzenia usługi Git powinien wykonać następujące zdanie:
    • W przypadku zastosowania to zatwierdzenie spowoduje <your subject line here>.
  • Dołącz zwięzły opis zmiany z zastosowaniem formy trybu rozkazującego w czasie teraźniejszym. Na przykład użyj add, nie added lub adds.
  • Ogranicz wiersz tematu do 50 znaków.
  • Zacznij od wielkiej litery i nie kończ kropką (.).
  • Możesz użyć emoji lub @mention innych użytkowników usługi GitHub w wierszu tematu, ale pamiętaj, że nie wszystkie projekty zezwalają na to lub zachęcają.

W treści komunikatu i żądania ściągnięcia kontynuuj używanie czasu teraźniejszego. Pamiętaj, aby opisać motywację dotyczącą zmiany. Porównaj swoją zmianę z poprzednim zachowaniem. Użyj miejsca do dyspozycji, aby wyjaśnić , co i dlaczego w porównaniu z tym, jak.

Komunikat dotyczący zatwierdzenia powinien dotyczyć tylko zawartości, którą zamierzasz przesłać. Zatwierdzaj lub przesyłaj do przeglądu małe, izolowane zestawy zmian. Zwiększa to prawdopodobieństwo, że Twoje zmiany zostaną scalone z projektem.

Dodawanie szczegółowości

Przed przesłaniem żądania ściągnięcia zapoznaj się z opcjami znajdującymi się na pasku bocznym. Wybierz pozycję Recenzenci lub Przypisani, jeśli znasz strukturę zespołu projektu. Dodaj etykiety , gdy istnieją wskazówki dotyczące używania etykiet, na przykład w pliku CONTRIBUTING.md. Etykiety mogą pełnić rolę wizualnych wskazówek dotyczących tego, co chcesz osiągnąć. Osoby odpowiedzialne za projekt również mogą dodawać etykiety.

Wskazówka

Jeśli repozytorium ma plik CONTRIBUTING.md lub szablon żądania ściągnięcia, postępuj zgodnie ze wskazówkami dotyczącymi wypełniania żądania ściągnięcia.

Niektóre etykiety używane w repozytorium na potrzeby tego modułu Learn są następujące:

  • Usterka (czerwona): Coś nie działa
  • Dokumentacja (niebieski): ulepszenia lub dodatki do dokumentacji
  • Duplikat (szary): ten problem lub żądanie ściągnięcia już istnieje
  • Ulepszenia (teal): nowa funkcja lub żądanie

Opcjonalnie możesz połączyć problemy na pasku bocznym, gdzie pomyślne scalenie żądania ściągnięcia może zamknąć odpowiedni problem. Możesz również dostosować subskrypcję do powiadomień w wątku. Niektóre żądania ściągnięcia otrzymują wiele komentarzy, przeglądów i powiadomień dotyczących ciągłej integracji/ciągłego wdrażania. Dostępne są następujące opcje:

  • Nie subskrybujesz: Otrzymujesz powiadomienia tylko wtedy, gdy uczestniczysz lub zostałeś oznaczony @mentioned
  • Subskrybowane: Otrzymywanie wszystkich powiadomień dotyczących tego żądania ściągnięcia
  • Zwyczaj: Powiadamianie tylko o wybranych zdarzeniach

Ćwiczenie

Korzystając z projektu First Contributions, przećwicz forkowanie, klonowanie i przesyłanie żądania dodania. Projekt First Contributions ma na celu "wskazówki dotyczące sposobu, w jaki początkujący wprowadzą swój pierwszy wkład". Zawiera on przewodniki dotyczące korzystania zarówno z wiersza polecenia, jak i kilku graficznych interfejsów użytkownika (GUI). Projekt obsługuje również wiele języków. Pamiętaj o sprawdzeniu folderu Translations.

Pamiętając o lekcjach wykonywanych w poprzedniej jednostce i o informacjach zamieszczonych tutaj, wróć do otwieranego niedawno żądania ściągnięcia. Możesz też przejść do karty żądań ściągnięcia oglądanego projektu. Zwróć uwagę, że dobry wiersz temat ma duże znaczenie. Spróbuj odpowiednio zaktualizować żądanie ściągnięcia. Poświęć mniej więcej tyle samo czasu na napisanie żądania ściągnięcia, ile poświęcono na wprowadzanie zmian w projekcie. Pomoże to osobom odpowiedzialnym za projekt odpowiednio skategoryzować i spriorytetyzować (sklasyfikować) kontrybucje społeczności.

Premia: Zapoznaj się z wytycznymi i wymaganiami firmy Microsoft dotyczącymi ułatwień dostępu. W szczególności zapoznaj się z informacjami na temat opisywania interakcji z interfejsem użytkownika, aby uniknąć używania ableistycznego języka w swoich wypowiedziach. Klienci podczas korzystania z produktów używają różnych metod wprowadzania danych. Mogą na przykład korzystać z klawiatury, myszy, dotyku, głosu i innych. Lepiej używać takich czasowników, które będą odpowiednie w przypadku wszystkich metod interakcji z programem. Na przykład użyj select zamiast kliknięcia lub przeciągnięcia.