Como contribuir?
Para contribuir com o projeto, basta seguir os passos abaixo:
🛠 Issues
Encontrando um problema:
Se você identificar um problema na aplicação, verifique se já existe um problema relacionado. Se não existir, você pode abrir uma nova issue de Bug Report utilizando o template disponível. Adicione o label de bug
a issue e siga as instruções contidas no template.
Resolver um problema:
Dê uma olhada em nossas issues para encontrar uma que lhe interesse. Você pode refinar a pesquisa usando as labels
como filtros e, se for a sua primeira issue, tente procurar por good first issue
. Se encontrar um problema disponível para trabalhar, você é bem-vindo para abrir um Pull Request.
Encontrando erros na documentação
Caso você encontre algum erro na documentação, você pode abrir uma nova issue de Docs repair utilizando o template disponível. Adicione o label de docs
a issue e siga as instruções contidas no template.
Como propor novas funcionalidades
Para propor uma melhoria ou nova funcionalidade, você pode abrir uma nova issue de Feature Request utilizando o template disponível e adcionar o label de feature request
a issue. Sua sugestão será analisada e, se aprovada, será aberta uma task para a implementação desta nova funcionalidade.
Como fazer alterações?
Para fazer alterações você deve, primeiramente, seguir os passos para executar o projeto, e então:
- Usando o padrão GitHub Flow, crie uma branch apropriada para o que você irá implementar.
- Faça os commits separados para cada escopo de modificação, além de adicionar uma mensagem correta e descritiva.
⚙️ Pull Request
Quando terminar as alterações, crie uma pull request (PR).
- Não se esqueça de vincular o PR a uma issue se estiver resolvendo uma.
- Assim que enviar seu PR, um membro da equipe revisará sua proposta. Podemos fazer perguntas ou solicitar informações adicionais.
- Podemos solicitar alterações antes que um PR possa ser aceito.
- Conforme você atualiza seu PR e aplica alterações, marque cada conversa como resolvida.
- Se você encontrar conflitos no momento do merge, consulte este tutorial do github para ajudá-lo a resolver.
Seu PR foi aceito!
Parabéns 🎉. A equipe agradece!