Às vezes, é necessário deixar comentários sobre o código-fonte no repositório como um todo, por exemplo, ao aceitar o código para suporte de outros desenvolvedores ou ao conectar-se a um novo projeto.
Os processos de revisão no Github e seus análogos são construídos em torno das alterações feitas e, no nosso caso, os comentários precisam ser enviados para o estado de todo o código do sistema no momento dos comentários.
Como fazer isso usando o próprio git: corrija o estado no ramo de revisão e deixe seus comentários na solicitação de mesclagem para esse ramo.
Em geral, a essência do método já foi declarada, abaixo estão apenas alguns detalhes.
Questão
Imagine a situação: eles fornecem um repositório com o código e pedem sua opinião sobre ele. Normalmente, nesses casos, os comentários são feitos em um documento / tarefa / página separado em confluência etc., o que não é muito conveniente, como:
- Os comentários podem ficar obsoletos durante o processo de gravação, pois o desenvolvimento pode continuar.
- É difícil fazer referência a seções individuais do código; referências como duvidoso / bar.js: 4 são simplesmente inconvenientes para alternar constantemente entre o documento e o código.
- Isoladamente do código, o documento é perdido com uma probabilidade bastante alta.
Método de revisão de código do 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 a possibilidade de ter reinventado a bicicleta e que exista um método melhor para esses casos; ficarei grato por apontar o melhor caminho.
A idéia para esse método não foi inventada por mim, mas sugerida por um desenvolvedor, se Artem expressar um desejo, indicarei como autor.