Jak przesyłać żądania ściągnięcia

Aby wprowadzić zmiany w zawartości, prześlij żądanie ściągnięcia z rozwidlenia. Aby można było scalić żądanie ściągnięcia, należy przejrzeć żądanie ściągnięcia. Aby uzyskać najlepsze wyniki, przed przesłaniem żądania ściągnięcia zapoznaj się z listą kontrolną redakcyjną .

Korzystanie z gałęzi usługi Git

Domyślną gałęzią main dla PowerShell-Docs jest gałąź . Zmiany wprowadzone w gałęziach roboczych są scalane z gałęzią main przed opublikowaniem. Gałąź main jest scalona z gałęzią live każdego dnia tygodnia o godzinie 15:00 (czas pacyficzny). Gałąź live zawiera zawartość opublikowaną w docs.microsoft.com.

Przed rozpoczęciem jakichkolwiek zmian utwórz gałąź roboczą w lokalnej kopii repozytorium PowerShell-Docs. Podczas pracy lokalnie przed utworzeniem gałęzi roboczej należy zsynchronizować repozytorium lokalne. Gałąź robocza powinna zostać utworzona na podstawie kopii main od początku aktualizacji gałęzi.

Wszystkie żądania ściągnięcia powinny być kierowane do main gałęzi . Nie przesyłaj zmian do live gałęzi. Zmiany wprowadzone w main gałęzi są scalane z liveelementem , zastępując wszelkie zmiany wprowadzone w gałęzi live.

Usprawnij proces żądania ściągnięcia dla wszystkich

Prostszy i bardziej skoncentrowany można dokonać żądania ściągnięcia, tym szybciej można je przejrzeć i scalić.

Unikaj żądań ściągnięcia, które aktualizują dużą liczbę plików lub zawierają niepowiązane zmiany

Unikaj tworzenia reguł ściągnięcia zawierających niepowiązane zmiany. Oddzielaj drobne aktualizacje istniejących artykułów od nowych artykułów lub artykułów w dużym stopniu pisanych od nowa. Pracuj nad tymi zmianami w oddzielnych gałęziach roboczych.

Zbiorcze zmiany tworzą żądania ściągnięcia z dużą liczbą zmienionych plików. Ogranicz żądania ściągnięcia do maksymalnie 50 zmienionych plików. Duże żądania ściągnięcia są trudne do przejrzenia i bardziej podatne na błędy.

Zmienianie nazw lub usuwanie plików

Podczas zmieniania nazwy lub usuwania plików musi występować problem związany z żądaniem ściągnięcia. Ten problem musi omawiać konieczność zmiany nazwy lub usunięcia plików.

Unikaj mieszania dodawania zawartości lub zmieniania nazw plików i usuwania. Każdy plik, którego nazwa została zmieniona lub usunięta, musi zostać dodany do globalnego pliku przekierowania. Jeśli to możliwe, zaktualizuj wszystkie pliki, które łączą się ze zmienioną lub usuniętą zawartością, w tym wszystkie pliki spisu treści.

Usługa walidacji żądania ściągnięcia dokumentów

Usługa weryfikacji żądań ściągnięcia witryny Docs to aplikacja GitHub, która uruchamia reguły sprawdzania poprawności zmian. Należy naprawić błędy lub ostrzeżenia zgłoszone przez usługę walidacji.

Zaobserwujesz następujące zachowanie:

1. Przesyłasz żądanie ściągnięcia.

2. W GitHub komentarz wskazujący stan żądania ściągnięcia zobaczysz stan "kontrole" włączone w repozytorium. W tym przykładzie są włączone dwa testy: "Commit Validation" i "OpenPublishing.Build":

   

   Kompilacja może przejść nawet wtedy, gdy walidacja zatwierdzenia zakończy się niepowodzeniem.

3. Kliknij pozycję Szczegóły, aby uzyskać więcej informacji.

4. Na stronie szczegółów są dostępne wszystkie testy walidacji zakończone niepowodzeniem wraz z informacjami o sposobie rozwiązania problemów.

5. Po pomyślnej walidacji następujący komentarz zostanie dodany do żądania ściągnięcia:

   

Uwaga

Jeśli jesteś współautorem zewnętrznym (a nie pracownikiem firmy Microsoft), nie masz dostępu do szczegółowych raportów kompilacji ani linków do wersji zapoznawczej.

Po przejrzeniu żądania ściągnięcia może zostać wyświetlony monit o wprowadzenie zmian lub naprawienie komunikatów ostrzegawczych dotyczących walidacji. Zespół PowerShell-Docs może pomóc w zrozumieniu błędów walidacji i wymagań redakcyjnych.

Następne kroki

PowerShell-Docs — przewodnik dotyczący stylu

Dodatkowe zasoby

Jak zarządzamy żądaniami ściągnięcia