A veces es necesario dejar comentarios sobre el código fuente en el repositorio como un todo, por ejemplo, al aceptar código para soporte de otros desarrolladores o al conectarse a un nuevo proyecto.
Los procesos de revisión en Github y sus análogos se basan en los cambios realizados, y en nuestro caso, se deben hacer comentarios sobre el estado de todo el código del sistema al momento de comentar.
Cómo hacer esto usando git en sí mismo: corrija el estado en la rama de revisión, luego deje sus comentarios en la solicitud de fusión para esta rama.
En general, la esencia del método ya se ha establecido, a continuación se detallan algunos detalles.
Problema
Imagina la situación: te dan un repositorio con el código y te piden tu opinión al respecto. Por lo general, en tales casos, los comentarios se hacen en un documento / tarea / página separado en confluencia, etc., lo cual no es muy conveniente ya que:
- Los comentarios pueden quedar obsoletos durante el proceso de escritura, ya que el desarrollo puede continuar.
- Es difícil hacer referencia a secciones individuales del código; referencias como dudosas / bar.js: 4 son simplemente inconvenientes para cambiar constantemente entre el documento y el código.
- En forma aislada del código, el documento se pierde con una probabilidad bastante alta.
Método de revisión del código del sistema
, : , 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.
, .
Admito plenamente la posibilidad de que reinventé la bicicleta y de que existe un método mejor para tales casos, entonces agradeceré señalar la mejor manera.
La idea de este método no fue inventada por mí, sino sugerida por un desarrollador, si Artem expresa un deseo, lo indicaré como autor.