Best practices voor het indienen van pull-aanvragen

Als u inhoudelijke wijzigingen wilt indienen, dient u een pull-aanvraag in vanuit uw fork. Het indienen en verwerken van pull-aanvragen wordt behandeld in de werkstromen kleine/onregelmatige wijzigingen en primaire/langdurige wijzigingen.

Elke pull-aanvraag moet worden gecontroleerd voordat deze wordt samengevoegd. Lees dit artikel voor meer informatie over het werken met revisoren van pull-aanvragen en over hoe u pull-aanvragen kunt maken die gemakkelijker en sneller kunnen worden gecontroleerd, zodat de wachtrij voor pull-aanvragen voor iedereen beter werkt.

Werken met revisoren van pull-aanvragen

Pull-aanvragen worden doorgaans onderworpen aan een technische controle, een controle op de kwaliteit van de inhoud, of allebei, om de kwaliteit te waarborgen.

Technische controle

Voor sommige teams is een technische controle van de inhoud van pull-aanvragen vereist voordat deze kunnen worden doorgezet naar de kwaliteitscontrole van de inhoud en tenslotte het samenvoegstadium. Als uw team technische controles uitvoert, ontvangt u waarschijnlijk een uitnodiging en een koppeling naar de pull-aanvraag om feedback te geven. De feedbackmechanismen die worden gebruikt voor het controleren en bijwerken van pull-aanvragen verschillen, afhankelijk van het gebruikte hulpprogramma. Neem voor meer informatie contact op met het team voor technische controles.

Kwaliteitscontrole van inhoud

Hieronder vindt u basisinformatie over het werken met revisoren tijdens het proces voor kwaliteitscontrole van de inhoud.

  • De rol van de revisor voor inhoudskwaliteit begrijpen. De revisor:

    • Waarborgt de basiskwaliteit van de inhoud.
    • Voorkomt regressie in de opslagplaats.
    • Levert feedback voorafgaand aan het samenvoegen.

    Revisoren van inhoudskwaliteit hebben een rol in het beheren van inhoud. De primaire opzet is niet het eenvoudigweg zo snel mogelijk samenvoegen van alles wat wordt ingediend. Verwacht feedback op basis waarvan u updates moet doorvoeren, met name voor nieuwe artikelen en artikelen met ingrijpende wijzigingen. De revisor voor inhoudskwaliteit is tevens verantwoordelijk voor de laatste stap van het samenvoegen van de pull-aanvraag als dit aan alle kwaliteitscriteria voor inhoud voldoet.

  • Plan vooruit met uw revisor voor pull-aanvragen:

    • Voor pull-aanvragen met hoge prioriteit.
    • Voor pull-aanvragen voor inhoud die op een vast tijdstip of een vaste datum moet worden uitgegeven.
    • Voor pull-aanvragen waardoor veel bestanden worden gewijzigd of toegevoegd.
  • Het kan enkele dagen duren voordat pull-aanvragen zijn samengevoegd

    Hoewel revisoren voor inhoudskwaliteit proberen ten minste tweemaal per dag pull-aanvragen te reviseren/samen te voegen, hebben ze ook andere werkzaamheden. Het is goed mogelijk dat enkele van die werkzaamheden belangrijker zijn dan het beoordelen van pull-aanvragen.

Zorg ervoor dat de wachtrij voor pull-aanvragen voor iedereen beter werkt

In de wachtrij voor pull-aanvragen hebben we te maken met twee vaststaande feiten:

  • Voor pull-aanvragen met een kleine omvang en die veel soortgelijke wijzigingen bevatten, is minder tijd nodig voor de controle.
  • Voor pull-aanvragen met een grote omvang, of die veel verschillende soorten wijzigingen door elkaar bevatten, is meer tijd nodig voor de controle.

Met de volgende best practices laat u de wachtrij voor pull-aanvragen beter werken:

  • Scheid kleine updates aan bestaande artikelen van nieuwe artikelen of artikelen die grotendeels zijn herschreven. Behandel deze wijzigingen in aparte werkstromen.

  • Als u artikelen of afbeeldingen verwijdert, plaatst u deze verwijderingen dan niet tussen toevoegingen van inhoud of updates. Verwerk de toevoegingen en updates in een afzonderlijke vertakking van de werkstroom.

  • Als u een Microsoft-medewerker bent:

    • Neem alleen wanneer dit absoluut noodzakelijk is contact op met de revisor van pull-aanvragen om deze te verzoeken pull-aanvragen met spoed te behandelen. U kunt voor pull-aanvragen op het gebied van Red Zone, privacy, juridische zaken en beveiligingszaken, voor daadwerkelijk verstoorde klantervaringen en voor escalaties naar leidinggevenden een verzoek indienen deze met spoed te behandelen.

    • Plan releases of herstructurering van inhoud met uw revisor van pull-aanvragen. Mogelijk hebt u zijn of haar hulp nodig bij het maken van een releasevertakking of het coördineren van samenvoegmomenten met publicatiemomenten zodat uw inhoud op het juiste moment wordt gepubliceerd.

    • Als u out-of-band-updates van anderen wilt coördineren met wijzigingen die u maakt, en die van elkaar afhankelijk zijn, moet u dit werk vooraf coördineren met uw revisor van pull-aanvragen. Anders kan een groot aantal verbroken koppelingen ontstaan.

Hebt u haast? Dien pull-aanvragen in die automatisch kunnen worden geaccepteerd (Microsoft-medewerkers)

Gebruik, indien uw opslagplaats dit ondersteunt, de automatiseringsregels van PRMerger om een groter deel van uw dagelijkse pull-aanvragen automatisch te laten samenvoegen.

PRMerger kan uw pull-aanvraag automatisch accepteren als:

  • deze invloed heeft op maximaal tien bestanden.
  • deze maximaal vijftien doorvoeringen bevat.
  • Minder dan 20 procent van de tekst wordt gewijzigd.
  • er geen selectors/schakelaars worden bijgewerkt.
  • er geen bestanden worden verwijderd of toegevoegd.
  • er geen afbeeldingen worden toegevoegd, gewijzigd of verwijderd.

Moet u veel kleine wijzigingen doorvoeren?

Volg de bovenstaande automatiseringsregels van PRMerger en doe het volgende:

  • Dien artikelen met kleine wijzigingen met maximaal 10 bestanden gezamenlijk in één pull-aanvraag in.
  • Maak een aparte pull-aanvraag voor artikelen waarin afbeeldingen of selectors zijn gewijzigd. Deze moeten door een medewerker worden gecontroleerd.
  • Maak een aparte pull-aanvraag voor nieuwe of verwijderde artikelen. Deze moeten door een medewerker worden gecontroleerd.