Ficamos felizes pelo seu interesse em contribuir com o Syki!
Siga os passos abaixo para colaborar de forma eficiente com o projeto:
- Fork o repositório
-
Clique em "Fork" no topo da página.
-
Clone seu fork para sua máquina:
git clone https://github.com/seu-usuario/syki.git cd syki
- Crie uma branch
-
Use um nome descritivo para a sua branch:
git checkout -b minha-feature-legal
- Faça suas alterações
- Adicione sua feature, correção ou melhoria.
- Certifique-se de seguir o padrão de organização do código.
- Escreva commits claros
-
Exemplo:
git commit -m "feat: adiciona exportação de boletins em PDF"
- Teste suas alterações
-
O projeto possui testes automatizados. Sempre que possível, execute:
dotnet test
- Abra um Pull Request
- Depois de fazer push da sua branch, vá até o GitHub e abra um PR.
- Descreva claramente o que sua contribuição faz.
- Marque o @ZaqueuCavalcante ou mantenedores caso precise de revisão.
- Prefira alterações pequenas e bem definidas.
- Se for algo maior, abra uma issue antes para discutirmos juntos.
- Use
docker-compose uppara rodar o projeto localmente.
Ao enviar contribuições, você concorda com os termos da licença do projeto.
Obrigado por fazer parte do projeto Syki!
Juntos construímos ferramentas melhores para a educação.