como-contribuir.md

← README

Como Contribuir

• Verifique as Issues que estão abertas e se já não existe alguma com a sua feature;
• Abra uma Issue com o nome e descrição da sua feature e assine com o seu usuário informando que irá fazê-la;
• Faça um fork do repositório;
• Instale as dependências do [Commitlint] utilizando o comando: yarn ou npm install na raíz do repositório;
• Entre no sua página do GitHub e faça um clone do seu fork;
• Crie uma branch com o nome da sua feature: git chechout -b feat/minhaFeature;
• Faça as alterações necessárias no código ou na documentação;
• Instale as dependências do commitlint na raíz do projeto para a verificação dos commits: npm install ou yarn;
• Faça o commit das suas alterações seguindo as convenções de commit, adicione na descrição o id da sua Issue em parênteses e lembre de fechar a sua Issue com o id no rodapé do commit:

  <tipo>(escopo opcional): <descrição> (#x)

  [corpo do commit]

  Close #x

Exemplo:

  feat: adicionado componente para tal coisa (#52)

  Foi adicionado um componente para tal coisa com o objetivo de melhorar tal coisa, deixando o projeto de tal maneira.

  Close #52

• Faça um push para a sua branch: git push origin feat/minhaFeature;
• Agora é só abrir um pull request no repositório que você fez o fork e assim que acontecer o merge sua Issue será fechada e suas alterações irão fazer parte do projeto;
• Depois que o merge da sua pull request for feito, você pode deletar a sua branch.

* Obrigado por contribuir! ❤️ 👊 😊