É com um enorme prazer que preparamos este guia de contribuições, para que pessoas como você possam nos ajudar a desenvolver um software de qualidade.
Você achou um bug no nosso projeto?
-
Sugestões para melhorias são rastreadas através das issues.
-
Fique atento também ao nossos templates de issues e Pull Requests
-
Verifique se nenhum Pull Request já foi criado por outra pessoa referente ao mesmo bug.
-
Se não for o caso, crie um Pull Request explicando de maneira clara e objetiva o que foi feito e quais foram suas motivações.
Contamos com a sua colaboração para que possamos melhorar a cada dia. Por esse motivo você é mais que bem-vindo(a) para mandar sugestões de melhorias! Pedimos apenas que você seja o mais objetivo possível em suas descrições e que se atente as issues e aos Pull Requests abertos, para que não haja informações repetidas.
Oba! você decidiu nos ajudar!! Desde já agradecemos seu esforço para nos ajudar! Fique agora com algumas dicas que vão te ajudar:
-
Faça um fork do projeto e crie uma nova branch.
-
Caso deseje trabalhar nas nossas issues, comente na issue escolhida. Isso vai mostrar para as outras pessoas que você está trabalhando nela.
-
Antes de fazer qualquer coisa, busque rodar o projeto localmente.
-
Rode os testes localmente, isso é uma boa prática.
-
Adicione novos testes para novas funcionalidades ou bugs.
-
Não se esqueça de usar o tempo presente nas mensagens do commit. Por exemplo "Cria funcionalidade nova" e não "Criada funcionalidade nova".
-
As mensagens de commit, Pull Request, comentários e issues deverão estar em português.
Obrigado por ler até aqui, esperamos sua colaboração em breve, a equipe do QuantiFGA agradece a sua atenção. 😄