Este é um documento para orientação em como contribuir para o repositório do aplicativo android do Escola em Casa DF. Antes de começar a contribuir veja as issues já abertas, e a nossa documentação e arquitetura.
Veja as orientações abaixo para cada tipo de contribuição:
- Por onde começar a contribuir?
- Reportar erros
- Consertar erros
- Contribuir para a documentação
- Adicionar nova feature
Quer começar a contribuir para o app android do Escola em casa DF? O processo em geral é bem simples:
- Crie uma issue descrevendo uma feature que você queira trabalhar ou entre em issues já abertas (caso comece por uma issue já existente comente na issue que você está desenvolvendo).
- Escreva seu código, testes e documentação
- Abra um pull request descrevendo as suas alterações propostas
- Seu pull request será revisado por um dos mantenedores, que pode levantar questões para você sobre eventuais mudanças necessárias ou questões.
Veja nossas issues, principalmente as com as tags help-wanted e good-first-issue, que são as ideais para começar a contribuir.
Caso tenha encontrado algum erro no aplicativo, nos informe por uma issue, assim poderemos estar sempre melhorando. Pedimos que seja descritivo, dessa forma poderemos identificar e reproduzir o erro para concerta-lo.
Antes de reportar o Bug, veja as issues com a tag bug e verifique se o erro identificado já não possui uma issue criada.
Para uma boa documentação:
- Nomeie a issue com um nome claro e descritivo de acordo com o problema;
- Descreva o passo a passo para chegar no erro encontrado;
- Mostre exemplos do erro ocorrido;
- Descreva o comportamento esperado e o comportamento obtido;
- Marque a issue criada com a tag
bug.
Veja a seguinte estrutura de issue:
**Descrição do erro encontrado:**
...
**Passo a passo para a reprodução do erro:**
1.
2.
...
**Comportamento esperado:** ...
**Comportamento obtido:** ...Para enviar a sua solução e consertar um bug existente, fork nosso repositório e crie um Pull Request descrevendo o problema e como ele foi corrigido.
Para uma bom Pull Request:
- Nomeie o PR de forma descritiva e clara de acordo com o problema resolvido;
- Descreva o problema e a sua solução;
- Marque a issue que o PR soluciona.
Veja o exemplo abaixo:
**Issue:** #[Número-da-Issue]
**Descrição do Problema:**
...
**Descrição da Solução:**
...Caso queira resolver uma issue já existente, comente na issue que está trabalhando, caso ainda não exista uma issue crie uma nova issue descrevendo o problema encontrado e marque com a tag documentation.
Para solucionar faça um PR com a descrição do que foi feito e a referência a issue que está resolvendo.
Aceitamos contribuições em todas as áreas do nosso código, desde que seja uma contribuição válida e traga reais melhorias para o projeto. Para fazer uma contribuição abra uma issue, com nome descritivo, especificando o que será feito. Veja o exemplo abaixo de um bom template a ser feito:
**Descrição da nova feature:**
...
**Porque essa feature melhoraria o código ou o produto:**
... Após fazer a issue, faça um fork do repositório e abra um Pull Request com sua nova feature. Dê um bom nome para o PR, especifique a sua solução e referêncie a issue relacionada. Veja o exemplo de uma estrutura de PR abaixo:
**Issue:** #[Número-da-Issue]
**Descrição da nova feature:**
...
**Descrição de como foi feito:**
**Descrição de como ela funciona:**
...Agradecemos desde já e contamos com a sua contribuição =D