Rédiger une demande d'extraction efficace

Les demandes d'extraction sont comme les éléments vitaux d'un dépôt. Ils permettent de tout garder en bonne santé et de bouger. Cette page explique en détail comment créer une demande d'extraction complète et facile à examiner, ce qui augmente les chances de fusion de votre partenaire.

Voici les étapes à suivre pour créer la meilleure relation de presse possible.

  1. Communiquer
  2. Configuration
  3. Utilisez un format compact
  4. Gardez l'eau propre
  5. Tester votre modification
  6. Communication (pt 2)

Communication

Avant de vous lancer et de commencer à écrire du code, il est utile de communiquer avec l'équipe principale pour qu'elle sache ce qui vous intéresse.

Si un problème vous intéresse, ajoutez un commentaire en indiquant que vous allez commencer à le résoudre. Cela garantit que nous n’avons pas plusieurs personnes travaillant sur la même chose. Un membre de l'équipe vous répondra pour confirmer qu'il s'agit bien de vous.

Si votre idée n'est pas couverte par un problème, veuillez en rédiger une avant de commencer à travailler. Cela permet à l'équipe de discuter de la meilleure façon de créer le changement avant de commencer à créer, ce qui vous évite de travailler à long terme.

Préparer l'atelier

Si c'est la première fois que vous contribuez à Blockly ou blockly-samples, commencez par la page de configuration du développement.

Gardez-le petit

Essayez toujours de faire des modifications mineures et précises. Nous préférons passer en revue plusieurs demandes mineures plutôt que de publier un seul communiqué de presse. Voici quelques bonnes pratiques à suivre:

  • Résolvez un problème. N'essayez pas de vous attaquer à plusieurs problèmes à la fois.
  • Limitez le champ d'application. En général, une demande d'extraction prend moins de 8 heures (en fonction de votre connaissance du codebase).
  • Utilisez des commits. Si votre demande d'extraction vous semble un peu importante, divisez les modifications en groupes logiques à l'aide des commits Git.

Gardez-le propre

Pourquoi se soucier du style de code ? Nous optons pour le long terme, et un style cohérent facilite la maintenance. Le style fait référence à la façon dont vous nommez vos variables, mais couvre également la structure de votre code, la rédaction de commentaires, etc. Dans la mesure du possible, nous utilisons des outils tels qu'eslint pour automatiser les vérifications de style.

En plus d'eslint, veuillez suivre les guides suivants:

Tester votre modification

Avant d'afficher une demande d'extraction, vous devez toujours vérifier que vos modifications fonctionnent, afin de ne pas avoir à revenir en arrière et à corriger cela plus tard. Voici quelques idées pour tester les différentes catégories de projets:

  • Pour les plug-ins: écrivez des tests mocha automatisés couvrant vos modifications.
  • Exemples: Testez manuellement toutes les fonctionnalités présentées.
  • Pour les ateliers de programmation: exécutez l'intégralité du tutoriel dans un environnement propre et testez les exemples de code que vous fournissez.

Communication

C'est la dernière partie, et sans doute la plus importante, de la création d'une RP: la rédaction du résumé.

Rédiger un bon récapitulatif des relations publiques aide les autres développeurs à examiner vos modifications. Vos modifications auront ainsi plus de chances d'être acceptées plus rapidement.

Votre résumé doit inclure des éléments tels que:

  • Problème lié à votre RP.
  • Ce qui change votre relations publiques
  • La façon dont vous avez testé votre modification.
  • Tout élément que les réviseurs examinent minutieusement.
  • Toute autre information dont vous pensez qu'ils ont besoin

Si vous suivez le modèle de relations publiques lors de la création de votre demande, vous n'avez rien d'autre à faire. Veillez simplement à être aussi concis et complet que possible.

Bonne continuation !