Este guia de estilo funciona como o guia oficial a seguir em seus projetos. Os revisores do Udacity usarão este guia para classificar seus projetos. A fim de reduzir a confusão sobre qual estilo os alunos devem seguir durante o curso de seus projetos, recomendamos que todos os alunos se refiram a este guia de estilo para seus projetos.
Mensagens de commit consistem em três partes distintas separadas por uma linha em branco: o título, um corpo opcional e um rodapé opcional. O layout tem esta aparência:
tipo: corpo do assunto
rodapéO título consiste do tipo de mensagem e assunto.
O tipo está contido dentro do título e pode ser um destes tipos:
Os assuntos não devem ter mais de 50 caracteres, devem começar com uma letra maiúscula e não terminar com um ponto.
Use um tom imperativo para descrever o que um commit faz, ao invés do que ele fez. Por exemplo, use change; not changed ou changes.
Nem todos os commits são complexos o bastante para garantir um corpo de texto, desta forma sendo opcional e apenas usado quando um commit requerir um pouco de explicação e contexto. Use o corpo de texto para explicar o o que e por que de um commit, não o como.
Quando escrevendo um corpo de texto, as linhas brancas entre o título e o corpo de texto é requerido e você deve limitar o tamanho de cada linha para não mais od que 72 caracteres.
O rodapé é opcional e é usado para referenciar IDs de rastreador de problemas.
feat: Resumir alterações em cerca de 50 caracteres ou menos
Texto explicativo mais detalhado, se necessário. Envolva-o em cerca de 72
caracteres ou algo assim. Em alguns contextos, a primeira linha é
tratada como o assunto do commit e o resto do texto como o corpo.
A linha em branco separando o resumo do texto do corpo do texto é crítica (a menos que
você omita o corpo inteiramente); várias ferramentas como `log`, `shortlog`
e `rebase` pode tornar as coisas confusas se você executar juntas.
Explique o problema que este commit está solucionando. Concentre-se em por que você
está fazendo essa mudança ao contrário de como o código explica isso.
Existem efeitos colaterais ou outras consequências não intuitivas desta
alteração? Aqui está o lugar para explicá-los.
Mais parágrafos vem após linhas em branco.
- Marcadores redondos são ok, também
- Normalmente um hífen ou um asterisco é usado para o marcador, precedido
por um único espaço, com linhas em branco entre, mas convenções
variam aqui
Se você usar um rastreador de problemas, coloque referências neles no rodapé,
por exemplo, assim:
Resolve: #123
Veja também: #456, #789