Todo tipo de contribuição ao Login Cidadão será bem-vinda, mesmo que não esteja totalmente de acordo com as orientações descritas aqui, entretanto é muito importante que você tente segui-las ao máximo para facilitar o entendimento e para que ela seja aceita mais rapidamente.
A seguir, apresentamos as formas de contribuição que possuem requisitos que devem ser atendidos para que a contribuição seja melhor recebida.
Se você encontrou um bug, pedimos que crie uma issue descrevendo o problema da forma mais clara possível, especificando os passos para reproduzi-lo e repassando as informações contextuais tanto da sua instalação quando da sessão onde ocorreu o problema.
A seguir temos uma lista de informações que podem ajudar seu problema a ser identificado e corrigido mais rapidamente:
- Passos para reproduzir o problema;
- Sistema Operacional e sua versão (ex: Debian 8);
- Versão do Login Cidadão (informe o commit que você está usando);
- Tipo de usuário (ex: não autenticado, usuário normal, administrador...);
- Você fez alguma modificação que não consta em um commit? Explique.
Solicitações de novas funcionalidades são tão bem-vindas quanto notificações de bugs. Caso tenha uma ideia para uma nova funcionalidade, basta criar uma issue descrevendo de forma clara o que você gostaria que estivesse presente no Login Cidadão e as pessoas interessadas no projeto poderão comentar, complementar, reforçar e até implementar sua sugestão.
Além de reportar problemas você pode corrigi-los, sem falar na possibilidade de implementar novas funcionalidades. Para isso, basta submeter um PR (Pull Request) contendo a alteração desejada. Entretanto alguns detalhes devem ser observados para que seu código seja aceito:
- Siga as PSR, principalmente a PSR-1 e a PSR-2;
- Certifique-se de que seu código seja 100% coberto por testes unitários, quando aplicável;
- Lembre de incluir o cabeçalho com informações sobre a licença do Login Cidadão;
- Faça suas alterações sobre o branch
master.