Manchmal ist es notwendig, Feedback zum Quellcode im gesamten Repository zu hinterlassen, z. B. wenn Sie Code zur Unterstützung durch andere Entwickler akzeptieren oder eine Verbindung zu einem neuen Projekt herstellen.
Die Überprüfungsprozesse in Github und seinen Analoga basieren auf den vorgenommenen Änderungen. In unserem Fall müssen zum Zeitpunkt des Kommentierens Kommentare zum Status des gesamten Systemcodes abgegeben werden.
So geht's mit git selbst: Korrigieren Sie den Status im Überprüfungszweig und hinterlassen Sie Ihre Kommentare in der Zusammenführungsanforderung für diesen Zweig.
Im Allgemeinen wurde das Wesentliche der Methode bereits dargelegt. Nachfolgend sind nur einige Details aufgeführt.
Problem
Stellen Sie sich die Situation vor: Sie geben Ihnen ein Repository mit dem Code und fragen Sie nach Ihrer Meinung dazu. In solchen Fällen werden Kommentare normalerweise in einem separaten Dokument / einer separaten Aufgabe / Seite in Konfluenz usw. abgegeben, was nicht sehr praktisch ist, da:
- Kommentare können während des Schreibvorgangs veraltet sein, da die Entwicklung fortgesetzt werden kann.
- Es ist schwierig, auf einzelne Abschnitte des Codes zu verweisen, Verweise wie zweifelhaft / bar.js: 4 sind einfach unpraktisch, um ständig zwischen dem Dokument und dem Code zu wechseln.
- Isoliert vom Code geht das Dokument mit relativ hoher Wahrscheinlichkeit verloren.
Methode zur Überprüfung des Systemcodes
, : , 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.
, .
Ich gebe die Möglichkeit voll und ganz zu, dass ich das Fahrrad neu erfunden habe und dass es für solche Fälle eine bessere Methode gibt, dann bin ich dankbar, dass ich den besten Weg aufgezeigt habe.
Die Idee für diese Methode wurde nicht von mir erfunden, sondern von einem Entwickler vorgeschlagen. Wenn Artem einen Wunsch äußert, werde ich dies als Autor angeben.