Skip to content

Files

Latest commit

 

History

History
34 lines (23 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

34 lines (23 loc) · 1.64 KB

Contribuindo com o Projeto

Não fode, porra! é um projeto 100% aberto e dependente da comunidade para sobreviver e prosperar. Através deste documento você poderá entender melhor que tipo de contribuições nós buscamos e como pretendemos integrá-las ao projeto.

Que tipo de ajuda precisamos?

Essencialmente toda ajuda é bem vinda e, portanto, não se sinta impedido(a) de abrir uma Issue a qualquer momento. Há algumas áreas chave no projeto que merecem atenção da comunidade e cujas contribuições serão muito bem vindas:

  • Design de Interface e UX
  • Front-end
  • Back-end
  • Conteúdo: análises, correções, sugestões de novos conteúdos

Como funciona o ciclo de vida do projeto?

A versão estável do projeto deverá sempre estar contida no branch master. Portanto somente branches cuja build esteja aprovada serão integrados.

O branch master é diariamente compilado e suas páginas geradas são enviadas ao branch gh-pages.

Como contribuir?

  • Abra uma issue descrevendo seus problema e/ou solução
  • Faça um fork do projeto para que o possua em seu perfil
  • Em seu fork, crie um branch que esteja relacionado com sua issue
  • Ao término de suas modificações, abra um Pull Request
  • Seu código será revisado e, se necessário, algumas modificações serão solicitadas

O que será avaliado?

  • Todo o dado utilizado deverá ser provindo de um site .gov.br
  • Todo novo dado deverá possuir documentação mínima que explique como se chegou a tal resultado
  • A build deverá estar sempre com o status "passed"