Generuj pull requesty i opisy PR bezpośrednio z twojego IDE. Bob analizuje zmiany, tworzy szczegółowe opisy i usprawnia przepływ pracy.

Dlaczego warto używać tej funkcji?

Oszczędzaj czas: Automatycznie generuj szczegółowe opisy PR na podstawie swoich zmian.
Utrzymuj spójność: Zapewnij, że wszystkie PR przestrzegają spójnego formatu.
Poprawiaj współpracę: Dostarczaj jasny kontekst dla recenzentów dzięki dobrze ustrukturyzowanym opisom.
Usprawniaj przepływ pracy: Twórz PR bez opuszczania swojego IDE.

Jak to działa

Bob analizuje zmiany w twojej gałęzi, historię commitów i nazwę gałęzi, aby zrozumieć cel i zakres twojej pracy. Następnie generuje znaczący tytuł PR i szczegółowy opis, który podsumowuje twoje zmiany, ułatwiając recenzentom zrozumienie kontekstu i celu twojego PR. Po wygenerowaniu możesz przejrzeć i edytować opis PR przed przesłaniem.

Proces generowania PR jest interaktywny, pozwalając wybrać gałąź docelową i zdalne repozytorium przed utworzeniem PR.

Rozpoczęcie pracy

Wymagania wstępne

Twoje zmiany muszą być zatwierdzone w gałęzi.
Musisz mieć dostęp do wysyłania do zdalnego repozytorium.

Podstawowe użycie

Możesz wybrać z 3 opcji, aby zainicjować przepływ PR:

Kliknij ikonę PR w panelu Source Control.
Użyj palety poleceń (Cmd + Shift + P na Mac, Ctrl + Shift + P na Windows/Linux) i wyszukaj "Bob: Generate PR".
Wpisz /create-pr w interfejsie czatu Boba.

Bob następnie poprowadzi cię przez następujące kroki:

Wybierz gałąź bazową, do której chcesz scalić. Bob zasugeruje trzy najbardziej prawdopodobne gałęzie.
Wybierz zdalne repozytorium, jeśli masz wiele zdalnych.
Przejrzyj wygenerowany opis i tytuł PR.
Utwórz PR.
Otrzymaj link do nowo utworzonego PR w swoim czacie.

Używanie szablonów dla opisów PR

Bob automatycznie wykrywa i używa istniejących szablonów PR twojego projektu podczas generowania opisów pull requestów. To zapewnia, że twoje PR są spójne z ustalonymi standardami twojego zespołu. Gdy Bob wykryje wiele szablonów PR w twoim projekcie, możesz wybrać, który szablon zastosować do swojego pull requesta.

Wykrywanie szablonów

Bob wyszukuje szablony PR w następujących lokalizacjach względem katalogu głównego twojego projektu:

${cwd}/pull_request_template.md
${cwd}/docs/pull_request_template.md
${cwd}/.github/pull_request_template.md
${cwd}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
${cwd}/PULL_REQUEST_TEMPLATE/pull_request_template.md
${cwd}/docs/PULL_REQUEST_TEMPLATE/pull_request_template.md

Jeśli Bob znajdzie wiele szablonów, Bob poprosi użytkownika o wybór, którego szablonu użyć dla opisu PR.

Domyślny szablon

Jeśli w twoim projekcie nie zostanie znaleziony żaden szablon, Bob używa wbudowanego szablonu, który zawiera:

Opisowy tytuł pochodzący z nazwy twojej gałęzi
Podsumowanie zmian
Kluczowe szczegóły implementacji
Informacje o testowaniu
Wszelkie istotne linki lub odniesienia

Edytowanie wygenerowanego opisu

Po wygenerowaniu opisu PR Bob prezentuje go bezpośrednio w czacie. Możesz wtedy:

Potwierdzić i kontynuować: Zatwierdzić opis w obecnej formie, aby przystąpić do tworzenia PR.
Poprosić o zmiany: Wpisać swoje uwagi w czacie, a Bob wygeneruje opis ponownie na podstawie twoich wskazówek. Możesz powtarzać ten proces tyle razy, ile potrzebujesz przed potwierdzeniem.

Dostosowywanie szablonów

Dla najlepszych rezultatów z generowaniem PR przez Boba:

Używaj jasnych nagłówków sekcji w swoich szablonach (np. ## Summary, ## Changes)
Uwzględnij tekst zastępczy, który dostarcza kontekstu (np. )
Rozważ dodanie sekcji dla instrukcji testowania i powiązanych problemów

Wskazówki i najlepsze praktyki

Używaj opisowych nazw gałęzi, aby pomóc Bobowi generować dokładniejsze opisy PR.
Przeglądaj i edytuj wygenerowany opis przed utworzeniem PR.

Pull requesty