Como descrever Commits e Pull Requests

Como sabemos o código que estamos trabalhando ou contribuindo não é nosso. Esse código é a representação do negócio, e a ele foram atribuido conhecimento através de um liguagem de programação.

De acordo com Sommerville(2007) um software não é somente composto por código, documentação também é código.
Mas e na ausência de documentação?

• Podemos escrever boas mensagens de commit e podemos descrever melhor nossos pull requests.

Mensagens de commit

As mensagens deve ser no modo imperativo, como “Fix something”, “Add name attribute”, “Change column name”. Jamais usar no passado.

Descrição dos Pull Request

Aqui você terminou sua feature ou bug. Você tem a tela de pull request do github, gitlab, bitbucket ou seja qual for o seu cliente web git que esteja usando.

Você vai descrever as mudanças importantes que fez. “Há mas eu já coloquei nas mensagens de commit”. Ótimo mas é importe descrever de uma forma mais subjetiva e pessoal na descrição do pull request.

Falar porque fez dessa forma, antes estava de outro jeito. Você pode anexar um print, ou um gif como está a tela agora.

Afinal é possível que haja um code review, e a issue fica bem descritiva. Isso é bom pra você mesmo.