Uma vez que o Idvogados é um projeto totalmente open source, qualquer pessoa/instituição pode contribuir da forma que desejar. Para isso basta seguir o guia de contribuição do projeto e nosso código de conduta.
Issues ou pull requests que não estejam de acordo com este guia serão recusados.
- Commits devem ser feitos em inglês.
- Issues, pull requests e revisões devem ser feitas em português para facilitar a comunicação e chegar a um consenso rapidamente.
- Desenvolva apenas em seu branch.
- Faça rebase com o dev antes de criar pull requests.
- Mantenha seu fork sempre atualizado
Como atualizar um fork?
- Crie um fork do projeto.
- No seu fork, crie uma branch a partir da dev. (seguimos o Git Flow)
- Configurar o ambiente e iniciar o projeto:
Requisitos:
# Entre no diretório do projeto
$ cd frontend/
# Instale as dependências
$ yarn
# Inicie o projeto localmente
$ yarn dev
- Na branch criada, faça suas alterações.
- Realize o commit seguindo este guia.
- Abra um pull request mencionando a issue relacionada.
Como criar um fork? Como criar um pull request de um fork?
- Faça commits pequenos, que descrevem alterações únicas.
- Sugerimos que siga as recomendações sobre como escrever mensagens de commits descritas neste link:
- Seja breve e suscinto no título das mensagens do commit.
- Use o corpo da mensagem para explicações adicionais.
- Burlar a verificação de linting (--no-verify).
- Criar testes fake apenas para passar na verificação.
Use issues para discutir problemas e ideias para o projeto.
- Descreva qual é o problema em questão.
- Se possível, dê soluções para o problema.
- Faça links para código ou para referências a outras issues/pull requests se necessário.
- Todas as contribuições devem ser baseadas em uma issue aberta e marcadas como pronta para implementar.