Guia de mensagens de confirmação

Mensagens de confirmação

Mensagens de commit claras facilitam a revisão de solicitações de pull e a geração de notas da versão. O projeto Blockly usa commits convencionais para ajudar com isso.

Cada commit precisa ter o formato:

<type>: <description>

[optional body]

[optional footer(s)]

O repositório principal do Blockly tem um linter de commit para ajudar a aplicar isso. Se a solicitação de envio tiver vários commits, o linter vai verificar o título. Se ele tiver um único commit, esse commit será verificado. O ideal é que tanto os commits individuais quanto o título da solicitação de pull sigam essas diretrizes.

Tipo

O tipo não pode estar vazio e precisa estar todo em letras minúsculas. Confira a seguir uma lista dos tipos aceitos.

  • chore:para commits que concluem tarefas rotineiras/automatizadas, como upgrade de dependências.

  • deprecate:para commits que suspendem o uso de funcionalidades.

  • feat:para commits que adicionam novas funcionalidades ao Blockly.

  • fix:para commits que corrigem bugs/erros no Blockly.

  • release:para commits relacionados ao lançamento de uma nova versão.

Alterações importantes

As confirmações que fazem mudanças significativas precisam anexar um ! após o tipo de confirmação. Mudanças incompatíveis são aquelas que podem prejudicar os desenvolvedores que usam o Blockly em seus apps, exigindo trabalho extra.

Exemplo: none fix!: return type of workspace.paste

As mudanças incompatíveis podem ter qualquer um dos tipos válidos acima.

Descrição

A descrição não pode estar vazia e precisa ter menos de 256 caracteres.

Corpo

O corpo é opcional. Se ela for fornecida, haverá uma linha em branco entre ela e a descrição. Ele precisa ser dividido em linhas de no máximo 256 caracteres.

Normalmente, é recomendável colocar esse tipo de informação na descrição da solicitação de pull, além de/em vez de diretamente no commit.

O rodapé é opcional. Se ele for fornecido, haverá uma linha em branco entre ele e o corpo. Ele precisa ser dividido em linhas de no máximo 256 caracteres.

Como corrigir commits não convencionais

Se você não usou commits convencionais ao fazer as modificações, há duas opções para corrigir as mensagens, dependendo de quantos commits você tem:

  1. Se a solicitação de envio tiver vários commits, edite o título para atender aos requisitos. Quando a solicitação de pull é mesclada, os outros commits são compactados para que o título se torne a mensagem de commit.

  2. Se a solicitação de envio tiver um único commit, corrija a mensagem usando git commit --amend e faça um push forçado das mudanças para o fork do Blockly. Isso vai atualizar automaticamente todas as solicitações de extração abertas associadas a essa ramificação. git push --force origin my-branch.