Pull Requests

Pourquoi utiliser cette fonctionnalité ?

• Gagner du temps : Générez automatiquement des descriptions de PR détaillées basées sur vos modifications.
• Maintenir la cohérence : Assurez-vous que toutes les PR suivent un format cohérent.
• Améliorer la collaboration : Fournissez aux réviseurs un contexte clair avec des descriptions bien structurées.
• Rationaliser le flux de travail : Créez des PR sans quitter votre IDE.

Comment ça fonctionne

Bob analyse vos modifications de branche, l'historique des commits et le nom de la branche pour comprendre le but et la portée de votre travail. Il génère ensuite un titre de PR significatif et une description détaillée qui résume vos modifications et facilite la compréhension du contexte et du but de votre PR par les réviseurs. Après la génération, vous pouvez examiner et modifier la description de la PR avant de la soumettre.

Le processus de génération de PR est interactif et vous permet de sélectionner la branche cible et le dépôt distant avant de créer la PR.

Premiers pas

Prérequis

• Vos modifications doivent être committées dans une branche.
• Vous devez avoir un accès push au dépôt distant.

Utilisation de base

Vous pouvez choisir parmi 3 options pour initier un flux de PR :

• Cliquez sur l'icône PR dans le panneau Source Control.
• Utilisez la palette de commandes (Cmd + Maj + P sur Mac, Ctrl + Maj + P sur Windows/Linux) et recherchez "Bob: Generate PR".
• Tapez /create-pr dans l'interface de chat Bob.

Bob vous guidera ensuite à travers les étapes suivantes :

1. Sélectionnez la branche de base dans laquelle vous souhaitez fusionner. Bob suggère les trois branches les plus probables.
2. Sélectionnez le dépôt distant si vous avez plusieurs remotes.
3. Examinez la description et le titre de PR générés.
4. Créez la PR.
5. Obtenez le lien vers la PR nouvellement créée dans votre chat.

Utiliser des modèles de description de PR

Bob détecte et utilise automatiquement les modèles de PR existants de votre projet lors de la génération de descriptions de Pull Request. Cela garantit que vos PR sont cohérentes avec les normes établies de votre équipe. Si Bob détecte plusieurs modèles de PR dans votre projet, vous pouvez sélectionner quel modèle appliquer à votre Pull Request.

Détection de modèle

Bob recherche des modèles de PR aux emplacements suivants relatifs à la racine de votre projet :

1. ${cwd}/pull_request_template.md
2. ${cwd}/docs/pull_request_template.md
3. ${cwd}/.github/pull_request_template.md
4. ${cwd}/.github/PULL_REQUEST_TEMPLATE/pull_request_template.md
5. ${cwd}/PULL_REQUEST_TEMPLATE/pull_request_template.md
6. ${cwd}/docs/PULL_REQUEST_TEMPLATE/pull_request_template.md

Si Bob trouve plusieurs modèles, Bob demandera à l'utilisateur de sélectionner quel modèle utiliser pour la description de la PR.

Modèle par défaut

Si aucun modèle n'est trouvé dans votre projet, Bob utilise un modèle intégré qui inclut :

• Un titre descriptif dérivé du nom de votre branche
• Un résumé des modifications
• Détails d'implémentation clés
• Informations de test
• Tous les liens ou références pertinents

Modifier la description générée

Après avoir généré la description de la PR, Bob la présente directement dans le chat. Tu peux alors :

• Confirmer et continuer : Approuver la description telle quelle pour poursuivre la création de la PR.
• Demander des modifications : Saisir ton retour dans le chat et Bob régénérera la description en fonction de tes indications. Tu peux itérer autant de fois que nécessaire avant de confirmer.

Personnaliser les modèles

Pour de meilleurs résultats avec la génération de PR de Bob :

• Utilisez des en-têtes de section clairs dans vos modèles (par exemple, ## Résumé, ## Modifications)
• Incluez du texte d'espace réservé qui fournit du contexte (par exemple, <!-- Décrivez le but de cette PR -->)
• Envisagez d'ajouter des sections pour les instructions de test et les problèmes connexes

Conseils et meilleures pratiques

• Utilisez des noms de branche descriptifs pour aider Bob à générer des descriptions de PR plus précises.
• Examinez et modifiez la description générée avant de créer la PR.