49 votes

Flux de travail pour la révision du code basée sur GitHub

J'envisage d'utiliser GitHub comme outil principal pour la révision du code. Avec des fonctionnalités comme les commentaires en ligne et la vue comparative, il semble avoir beaucoup de fonctionnalités que des outils comme Gerrit proposent.

Quelqu'un d'autre a-t-il utilisé GitHub pour cela ? Si oui, quel est votre flux de travail ? Et quelles ont été vos expériences, positives ou négatives, dans ce domaine ?

Au fur et à mesure que j'y réfléchirai et que je déterminerai ce qui nous convient le mieux, je modifierai ma question pour vous faire part de ma propre proposition de flux de travail.

MODIFIÉ avec le flux de travail proposé

Étape 0. Mettre en place un crochet post-recette en utilisant l'impressionnant revue.est .

Ensuite :

  1. Engagez-vous comme d'habitude avec commit -a -s mais dans le message de validation, ajoutez #reviewthis @username .

  2. Si la compilation échoue, la révision est ignorée jusqu'à ce que la compilation soit rétablie.

  3. Le réviseur commente le commit ligne par ligne ou au niveau du fichier.

  4. GitHub notifie automatiquement le révisé des commentaires.

  5. Le réviseur informe le destinataire par email lorsque les commentaires sont terminés avec un résumé de la révision.

  6. Le destinataire répond aux commentaires du réviseur dans GitHub, permettant au projet d'accéder à l'historique des révisions de code.

Mes plus gros problèmes concernent l'étape 2 et les étapes 4/5. Gerrit fonctionne bien pour ne pas demander de révision à moins que la construction ne réussisse ; j'aimerais pouvoir faire cela dans GitHub. Les étapes 4/5 peuvent également devenir ennuyeuses (plusieurs courriels) et réduire la nature automatique du processus de révision (nécessitant un résumé par courriel).

Nous utilisons Hudson comme serveur de construction, si cela peut aider.

Toute réflexion sur ces problèmes serait également utile.

24voto

Daenyth Points 11297

Je l'ai utilisé pour ça. Le flux de travail que j'ai utilisé est de faire votre travail sur une branche de sujet et d'envoyer une demande de pull sur cette branche. La ou les personnes chargées de la révision examinent le code et les commits, en utilisant des commentaires par ligne (et par-commit). Le codeur prend ce feedback et effectue un rebasement destructif sur cette branche thématique, le repousse (en réécrivant l'historique sur son repo github), puis le cycle de révision se répète jusqu'à ce que la fusion soit acceptable.

Edit : Un Githubber a publié sur son blog une description de la méthode qu'ils utilisent pour développer github lui-même, et c'est assez similaire à ce que j'ai proposé. enlace

2voto

dimus Points 2396

À mon travail, nous suivons à peu près le processus décrit à l'adresse suivante "Utiliser les demandes de pull" pour la révision du code et nous en sommes très satisfaits.

Prograide.com

Prograide est une communauté de développeurs qui cherche à élargir la connaissance de la programmation au-delà de l'anglais.
Pour cela nous avons les plus grands doutes résolus en français et vous pouvez aussi poser vos propres questions ou résoudre celles des autres.

Powered by:

X