Skip to content

Git

Jump to bottom
Zoey de Souza Pessanha edited this page Aug 2, 2022 · 2 revisions

Tunk based development

Essa é a representação do nosso fluxo de trabalho:

Padrão de nomenclatura de Branches

O padrão utilizado para definir o nome de uma branch segue:

  • prefixo/tarefa-executada

Prefixo

O prefixo definido no nome de cada branch está relacionada de acordo com o finalidade da branch:

  • feature - novas funcionalidades;
  • bugfix - correção de bugs;
  • hotfix - fix com certa urgência;
  • chore - uma tarefa simples (remove dependênicia, formata código, …);
  • release - agrupamento de mais de uma funcionalidade ou bugfix para deploy;

Regras

  • A separação de palavras após o prefixo é feita com hífen;

Pull Requests

Descrição

A descrição do PR deve conter o contexto do que está sendo executado na tarefa e principalemte ressaltar possíveis pontos de atenção para o code review ou para a execução dos testes.

Code Review

  • Os PR tem que passar pelo code review de ao menos um outro desenvolvedor.
  • Commits adicionais depois de um code review aprovado devem ser revisados novamente.
  • Se uma revisão precisar de alteração utilize a opção bloqueante Request for Changes.
  • Se for algo relacionado a gosto pessoal não alinhado entre o time previamente utilize o Comment.

Shortcut

Para vincular seu PR a uma story do Shortcut basta na descrição ou em um cometário adicionar o id da story entre colchete.

Ex:

[sc-109]

Lembre-se de sempre vincular suas tarefas aos PR criados. Se a sua tarefa não tem uma story, crie ela no Shortcut.

Estratégias de merge

Após aprovação, se a PR foi criada apontando para a branch dev, realize o merge usando a opção Squash and merge. Desta forma a feature é enviada em um commit só usando o próprio título da PR como mensagem do commit.

Para PR de release (criadas apontando para a branch main) usar a opção Create a merge commit.

Push Force

Quando precisar usar o push force em alguma branch dê preferência ao –force-with-lease sobre o --force para evitar sobrescrever código escrito por outras pessoas na mesma branch.

ex:

git push origin my-branch --force-with-lease

Commits Assinados

Primeiro instale o app GPG na sua máquina

Linux

sudo apt-get update && sudo apt-get install gpg2
git config --global gpg.program gpg2
git config --global commit.gpgsign true

MacOS

Instale o GPGTools

git config --global commit.gpgsign true

Configure a GPG Key no GitHub

  • https://help.github.com/en/articles/adding-a-new-gpg-key-to-your-github-account

Soluções de problemas

Unix

Usuários de sistemas Unix podem encontrar o erro error: gpg failed to sign the data. Nesse caso, é necessário adicionar as seguintes linhas no fim do arquivo de configuração do seu shell. Exemplos:

Fish
set -x GPG_TTY (tty)
ZSH e Bash
GPG_TTY=$(tty)
export GPG_TTY

Artigos:

Clone this wiki locally