Comment résumer une pull request pour la personne chargée de la revue
Un résumé de pull request aide à comprendre le problème, l'approche et les points qui méritent de l'attention. Il est surtout utile lorsque la description reflète les changements réellement fournis.
Commencez avec le bon contenu.
- Ce que vous fournissez
- un diff textuel déplié et le contexte de l'issue visible sur la page.
- Le résultat attendu
- Enregistrez un résumé des modifications observées, de leur raison et des tests réellement attestés par les éléments disponibles.
Comment fonctionne le processus.
Expliquez ce qui a changé et pourquoi, puis identifiez les questions de comportement, de compatibilité ou de migration étayées par le diff et les notes. Distinguez les tests effectués des tests simplement suggérés.
Les points à vérifier dans le résultat.
Comparez le résumé aux fichiers modifiés avant de le publier. N'affirmez pas qu'un test a réussi ou qu'un risque a été éliminé si les éléments fournis ne le démontrent pas.
Prévisualisez le Markdown pour vérifier les titres, les listes et les liens, ainsi que le texte. Conservez les références avec le document pour permettre au relecteur de retrouver les affirmations importantes dans les sources fournies.
Apprenez à partir de l’exemple détaillé.
L’exemple Markdown téléchargeable montre une organisation possible du résultat. Lisez-le avec l’exemple source et distinguez les faits consignés, les formulations proposées et les questions encore sans réponse.
L’exemple fourni est illustratif. Il ne s’agit pas d’une exécution enregistrée sur vos données.
Télécharger l’exemple ↓Utilisez-le avec vos propres contenus.
- Ouvrez la source à utiliser et activez WebAct dans cet onglet.
- Copiez la tâche depuis la section d’introduction, ajoutez les champs ou préférences nécessaires et vérifiez les actions proposées.
- Comparez le premier résultat à votre source. Demandez une correction ou un ajustement précis si nécessaire.