Pull-aanvragen verzenden
Als u wijzigingen wilt aanbrengen in inhoud, dient u een pull-aanvraag (PR) in vanuit uw fork. Een pull-aanvraag moet worden gecontroleerd voordat deze kan worden samengevoegd. Bekijk voor de beste resultaten de redactionele controlelijst voordat u uw pull-aanvraag indient.
Git-vertakkingen gebruiken
De standaardbranch voor PowerShell-Docs is de main
vertakking. Wijzigingen die zijn aangebracht in werk vertakkingen, worden samengevoegd in de main
vertakking voordat ze vervolgens worden gepubliceerd. De main
vertakking wordt elke weekdag om 18:00 uur samengevoegd in de live
vertakking (Pacific Time). De live
vertakking bevat de inhoud die wordt gepubliceerd naar docs.microsoft.com.
Voordat u wijzigingen start, maakt u een werkbranch in uw lokale kopie van de PowerShell-Docs opslagplaats. Wanneer u lokaal werkt, moet u uw lokale opslagplaats synchroniseren voordat u uw werkbranch maakt. De werkvertakking moet worden gemaakt op basis van een update-to-date kopie van de main
vertakking.
Alle pull-aanvragen moeten zich richten op de main
vertakking. Verzend geen wijziging naar de live
vertakking. Wijzigingen die in de main
vertakking zijn aangebracht, worden samengevoegd met live
wijzigingen die zijn aangebracht in live
.
Het pull-aanvraagproces beter laten werken voor iedereen
Hoe eenvoudiger en gerichter u uw pull-aanvraag kunt maken, hoe sneller deze kan worden beoordeeld en samengevoegd.
Vermijd pull-aanvragen die grote aantallen bestanden bijwerken of niet-gerelateerde wijzigingen bevatten
Vermijd het maken van PULL's die niet-gerelateerde wijzigingen bevatten. Scheid kleine updates aan bestaande artikelen van nieuwe artikelen of artikelen die grotendeels zijn herschreven. Behandel deze wijzigingen in aparte werkstromen.
Bulksgewijs wijzigingen maken PULL's met grote aantallen gewijzigde bestanden. Beperk uw pull-aanvragen tot maximaal 50 gewijzigde bestanden. Grote pull-aanvragen zijn moeilijk te controleren en gevoeliger voor fouten.
Bestanden een andere naam geven of verwijderen
Wanneer u de naam van bestanden wijzigt of verwijdert, moet er een probleem zijn dat is gekoppeld aan de pull-aanvraag. Dit probleem moet de noodzaak bespreken om de bestanden te wijzigen of te verwijderen.
Vermijd het combineren van toevoegingen van inhoud of wijziging met bestandsnamen en verwijderingen. Een bestand dat is hernoemd of verwijderd, moet worden toegevoegd aan het algemene omleidingsbestand. Werk indien mogelijk alle bestanden bij die een koppeling maken naar de hernoemde of verwijderde inhoud, inclusief inhoudsinhoud.
Docs PR-validatieservice
De Docs PR-validatieservice is een GitHub-app waarmee validatieregels voor uw wijzigingen worden uitgevoerd. U moet eventuele fouten of waarschuwingen oplossen die door de validatieservice zijn gerapporteerd.
U ziet het volgende gedrag:
U dient een PR in.
In de GitHub opmerking die de status van uw pull-aanvraag aangeeft, ziet u de status 'controles' ingeschakeld in de opslagplaats. In dit voorbeeld zijn er twee controles ingeschakeld: 'Validatie doorvoeren' en 'OpenPublishing.Build':
De build kan zelfs worden doorgegeven als de doorvoervalidatie mislukt.
Klik op Details voor meer informatie.
Op de pagina Details ziet u alle validatiecontroles die zijn mislukt, met informatie over wat u moet doen om de problemen op te lossen.
Als de validatie slaagt, wordt de volgende opmerking toegevoegd aan de pull-aanvraag:
Notitie
Als u een externe (geen Microsoft-werknemer) inzender bent, hebt u geen toegang tot de gedetailleerde buildrapporten of preview-koppelingen.
Wanneer de pull-aanvraag wordt beoordeeld, wordt u mogelijk gevraagd om wijzigingen aan te brengen of validatiewaarschuwingen op te lossen. Het PowerShell-Docs team kan u helpen bij het begrijpen van validatiefouten en redactionele vereisten.
Volgende stappen
Stijlgids voor PowerShell-documentatie
Aanvullende resources
Feedback
https://aka.ms/ContentUserFeedback.
Binnenkort beschikbaar: In de loop van 2024 zullen we GitHub-problemen geleidelijk uitfaseren als het feedbackmechanisme voor inhoud en deze vervangen door een nieuw feedbacksysteem. Zie voor meer informatie:Feedback verzenden en weergeven voor