Skip to content

Latest commit

 

History

History
101 lines (64 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

101 lines (64 loc) · 4.38 KB
Raw

Guia de Contribuição 😄

Bem vindo ao Mia Ajuda!

Adoramos quando novas pessoas contribuem com o projeto. Queremos que a sua contribuição para o Mia Ajuda se torne a mais simples possível. Todas as ajudas ao projeto são bem vindas, seja:

  • Reportando bugs encontrados;
  • Enviando correção de bugs;
  • Propondo novas soluções para o projeto, seja: Visual, Arquitetural ou de Negócio;
  • Propondo novas funcionalidades;
  • Implementado novas funcionalidades previstas em issues nos nossos repositórios.

Caso queira conhecer melhor nosso projeto, acesse o nosso site, nosso Instagram ou a nossa Organização no Github.

Para entrar em contato conosco, além de abrir uma issue aqui no Github, você pode nos enviar um email, para: miaajudadev@gmail.com

Como Iniciar a sua Contribuição ao Mia Ajuda

Muito Obrigado pelo interesse em contribuir para o Projeto.

Para iniciar a sua jornada, você pode estar contribuindo para o projeto abrindo issues em nosso repositório de documentação repositório, seguindo o nosso template. Essas issues podem ser abertas reportando possíveis bugs ou sugerindo novas funcionalidades para o projeto.

Caso você queira contribuir para o código do Mia Ajuda, basta seguir os próximos passos:

  • Busque a issue na qual você se identifica, se marque e comente nessa issue. Atenção: Certifique-se antes, de que a issue não está sendo resolvida por alguém, antes;
  • Faça um fork dos nossos repositórios, se você for um contribuidor externo;
  • Crie uma branch a partir da develop, seguindo nossas políticas de branch abaixo;
  • Crie um Pull Request com o status WIP, no repositório para nos certificarmos que você está trabalhando na sua issue;
  • Ao gerar commits, siga a nossa política de commits;
  • Ao concluir o desenvolvimento da issue, troque o status do seu Pull Request de WIP para Solve, seguindo o nosso template de Pull Request;
  • Após um revisor aprovar o seu Pull Request, mescle-o com a a branch base, seguindo a política do Squash Rebase;

Workflow de Trabalho

Todo o nosso workflow de trabalho é inteiramente baseado no GitFlow.

Politicas de Branches

As branches são dividas em camadas de desenvolvimento, baseado do modelo do GitFlow, sendo a main a camada que contém a aplicação em sua versão estável, a develop a versão de estado em desenvolvimento. Para a criação de feature branches utilize a develop como base.

O formato para os nomes das feature branches será composto por:

US + NUMERO_DA_US + FUNCIONALIDADE.

Exemplo:

US13-Creation_of_a_new_screen

Para hotfix branches, o formato do nome da branch se dará pela seguinte forma:

HOTFIX + NOME_DA_FIX

Exemplo:

hotfix_login_bug

Mantendo as branches atualizadas

Mantenha as suas branches atualizadas com a branch base. Utilize o comando rebase para isso.

Exemplo:

> git pull --rebase origin develop

Política de Commits

Os nossos commits possuem um lint, sendo obrigatório seguir esse padrão:

tipo do commit: descrição concisa e em inglês do commit

Exemplo:

git commit -m "feat: create login button"

As nossas regras são:

  • Commits devem ser redigidos em idioma inglês;
  • Devem seguir as regras do lint;
  • Devem ser simples e concisos, possuindo títulos curtos;
  • Devem iniciar com verbo no infinitivo informando o objetivo.

Commits em equipes

Caso mais de uma pessoa tenha trabalhado com você no commit, utilize do Co-authored-by, na descrição do commit.

Exemplo:

fix: fix contacts modal


Co-authored-by: Link <link.zelda@gmail.com>