Parfois, il est nécessaire de laisser des commentaires sur le code source dans le référentiel dans son ensemble, par exemple, lors de l'acceptation de code pour le support d'autres développeurs ou lors de la connexion à un nouveau projet.
Les processus de révision dans Github et ses analogues sont construits autour des modifications apportées, et dans notre cas, des commentaires doivent être donnés à l'état de tout le code système au moment de la commentation.
Comment faire cela en utilisant git lui-même: corrigez l'état dans la branche de révision, puis laissez des commentaires dans la demande de fusion pour cette branche.
En général, l'essence de la méthode a déjà été énoncée, voici quelques détails.
Problème
Imaginez la situation: ils vous donnent un référentiel avec le code et demandent votre avis à ce sujet. Habituellement, dans de tels cas, les commentaires sont faits dans un document / tâche / page séparé en confluence, etc., ce qui n'est pas très pratique car:
- Les commentaires peuvent devenir obsolètes pendant le processus d'écriture, car le développement peut se poursuivre.
- Il est difficile de se référer à des sections individuelles du code; des références telles que douteux / bar.js: 4 sont tout simplement peu pratiques pour basculer constamment entre le document et le code.
- Isolé du code, le document est perdu avec une probabilité assez élevée.
Méthode de révision du code système
, : , merge request .
https://github.com/oktend/system-review-example :
- ( dev):
https://github.com/oktend/system-review-example/commit/0514531a35edf19e7032eb49f45a98d019f83efe - , "system-review/1march2020-goodman":
https://github.com/oktend/system-review-example/tree/system-review/1march2020-goodman - , , "1march2020-goodman-issues":
https://github.com/oktend/system-review-example/tree/system-review/1march2020-goodman-issues - , , .
- merge request ( pull request) "system-review/1march2020-goodman-issues" -> "system-review/1march2020-goodman":
https://github.com/oktend/system-review-example/pull/1/files
:
https://github.com/oktend/system-review-example/network
merge request , .
, .
:
https://github.com/oktend/system-review-example/blob/c80b03710059b235347ec781bf08dca9c0e68f7d/review-1march2020-goodman.md
:
https://github.com/oktend/system-review-example/blob/c80b03710059b235347ec781bf08dca9c0e68f7d/foo.js
- github ( ), IDE, git.
, .
J'admets pleinement la possibilité que j'ai réinventé le vélo et qu'il existe une meilleure méthode pour de tels cas, alors je serai reconnaissant d'avoir indiqué la meilleure façon.
L'idée de cette méthode n'a pas été inventée par moi, mais suggérée par un développeur, si Artem exprime un désir, je l'indiquerai en tant qu'auteur.