Skip to content

Latest commit

 

History

History
41 lines (32 loc) · 5.5 KB

CONTRIBUTING.md

File metadata and controls

41 lines (32 loc) · 5.5 KB
Raw

Como contribuir com o Merenda+?

Ajudas são sempre bem vindas!

Caso queira contribuir com o projeto, comece lendo o README, para conhecer um pouco da nossa proposta e para ter um guia básico de como baixar e configurar o ambiente para rodar o projeto. Também é importante ler nosso Código de Conduta. Caso tenha mais dúvidas sobre a configuração de ambiente você pode acessar o Documento de Configuração do Ambiente.

Para mais informações sobre os aspectos gerais do projeto, acesse a Wiki e vá navegando pelos documentos que aparecem na Sidebar.

Enconcontrou um Bug?

  • Procure se esse bug já não é conhecido e se encontra em uma das nossas Issues. Os bugs devem estar marcados com tag (label) bug.

  • Caso o bug encontrado ainda não esteja em uma das nossas Issues, basta criar uma nova Issue. Sempre coloque um título significativo e uma breve descrição do problema, e, caso seja possível, anexar outras informações relevantes sobre o bug, como trechos de código, execução de um caso de teste, imagens, entre outros.

Deseja adicionar e/ou modificar uma funcionalidade?

  • Primeiro certifique-se que não existe nenhuma Issues com o mesmo propósito.

  • Caso não exista, crie uma nova Issue. Sempre dê um título significativo a ela e coloque uma breve descrição, além de colocar bons critérios de aceitação e ligá-la ao menos a uma label.

  • Se nenhuma das labels já existente conseguir satisfazer alguma nova Issue, sinta-se livre para criar uma nova que te atenda e ligue ela a sua Issue.

  • As mudanças devem ser submetidas através de Pull Requests e você pode encontrar o padrão de como ele deve ser feito no Pull Request Template.

  • Caso deseje saber os passos corretos para abrir uma Issue, você pode seguir o nosso Issue Template.

Tem alguma dúvida?

  • Caso tenha alguma dúvida pertinente ao projeto, você também pode criar uma nova Issue, marcando-a com a label question.

  • Antes de fazer alguma pergunta, pesquise se já não foi feita alguma parecida que possa sanar essa dúvida.

  • As dúvidas devem ser respondidas na própria Issue, assim como uma possível discussão. Se a dúvida for sanada, o autor deve fechar a Issue, mas pode reabrí-la caso for necessário.

Dicas importantes

Por ser um projeto de código aberto, onde várias pessoas podem contribuir, é importante definir alguns padrões para que o projeto possa progredir de forma coesa. Por isso, é importante dar algumas dicas para as pessoas que desejam contribuir:

  • Sempre que for criar uma Issue, dê um nome significativo a ela, assim como uma descrição completa sobre do que ela se trata. Isso facilita outras pessoas buscarem algo semelhante ao que já foi feito, evitando criar Issues com o mesmo propósito.
  • Sempre ligar as Issues a no mínimo uma label, que seja significativa para ela, sendo que isso é importante para manter a organização das Issues.
  • Manter o padrão que o código está sendo feito, como a organização de pastas, nome dos arquivos, identação, entre outros.
  • Para manter esses padrões, recomenda-se fortemente a utilização da folha de estilo disponível no projeto.
  • Testar as funcionalidades que foram implementadas e/ou modificadas, para manter a confiabilidade do código.

Essas foram apenas algumas dicas para que seja possível trabalhar cooperativamente a fim de evoluir o projeto. Além dessas, é importante sempre colocar em prática as boas práticas da comunidade, aplicando e disceminando seus conhecimentos, além de estar sempre aprendendo com o conhecimento das outras pessoas.

Obrigado por contribuir! Com certeza sua ajuda será importante!