Guia de mensagens de confirmação

Mensagens de confirmação

Mensagens de confirmação claras tornam as solicitações de envio mais fáceis de analisar e as notas de lançamento mais fáceis de gerar. O projeto Blockly usa confirmações convencionais para ajudar com isso.

Cada confirmação precisa ter o formato:

<type>: <description>

[optional body]

[optional footer(s)]

O repositório principal do Blockly tem um linter de confirmação para ajudar a aplicar isso. Caso sua solicitação de envio tenha várias confirmações, o linter verificará o título. Se ele tiver uma única confirmação, ele a verificará. É melhor que suas confirmações individuais e o título da solicitação de envio sigam essas diretrizes.

Tipo

O tipo não pode estar em branco e não pode estar em branco. Veja a seguir uma lista dos tipos aceitos.

tarefa
Para confirmações que concluem tarefas de rotina/automatizadas, como upgrade de dependências.
descontinuar
Para confirmações que descontinuam a funcionalidade.
feat
Para confirmações que adicionam novas funcionalidades ao Blockly.
fix
Para confirmações que corrigem bugs/erros no Blockly.
versão
Para confirmações relacionadas ao lançamento de uma nova versão.

Alterações importantes

Confirmações que fazem alterações interruptivas precisam anexar um ! após o tipo de confirmação. Alterações interruptivas podem impedir o uso do Blockly nos apps pelos desenvolvedores, fazendo com que precisem realizar um trabalho extra.

Exemplo: fix!: return type of workspace.paste

As alterações interruptivas podem ter qualquer um dos tipos válidos acima.

Descrição

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

Body

O corpo é opcional. Se fornecido, precisa haver uma linha em branco entre ele e a descrição. Ele precisa ser dividido em linhas de até 256 caracteres.

Normalmente, é aconselhável colocar esse tipo de informação na descrição da solicitação de envio, além da confirmação, em vez de diretamente.

O rodapé é opcional. Se fornecido, deve haver uma linha em branco entre a tag e o corpo. Ele precisa ser dividido em linhas de até 256 caracteres.

Como corrigir confirmações não convencionais

Caso você não tenha usado confirmações convencionais ao fazer modificações, há duas opções para corrigir as mensagens, dependendo de quantas confirmações tenham:

  1. Caso sua solicitação de envio tenha várias confirmações, edite o título dela para se adequar aos requisitos. Quando a solicitação de envio for mesclada, as outras confirmações serão comprimidas para que o título se torne a mensagem de confirmação.

  2. Se sua solicitação de envio tiver uma única confirmação, altere sua mensagem de confirmação usando git commit --amend e, em seguida, force o envio das alterações para sua bifurcação do Blockly. Isso atualizará automaticamente todas as solicitações de envio abertas associadas a esta ramificação. git push --force origin my-branch.