Skip to content

Latest commit

 

History

History
75 lines (57 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

75 lines (57 loc) · 2.74 KB
Raw

Contribuindo com o projeto

Coisas nas quais você pode ajudar:

Fluxo de trabalho

Todos os contribuidores do projeto devem seguir os seguintes passos:

  1. Puxe uma branch com base na branch master
  2. Nomeie a branch conforme as políticas de branches
  3. Trabalhe nas suas mudanças nesta branch
  4. Crie um pull request para a branch master do repositório
  5. Um mantenedor do projeto irá avaliar e realizar o merge da sua contribuição ou solicitar alterações na mesma

Desenvolvendo

  1. Clone o repositório
git clone https://github.com/deeplearningunb/emotion
  1. Abra o projeto Emotion no editor de texto de sua preferência
  2. Faça as suas contribuições

Politicas de branches

As branches devem ser nomeadas conforme o que será desenvolvido:

  • Para novas features, a branch deverá ser nomeada seguindo o seguinte padrão:
feature-nomedaissue
  • Para correção de bugs, a branch deverá ser nomeada seguindo o seguinte padrão:
bug-nomedaissue
  • Para envio de documentação, a branch deverá ser nomeada seguindo o seguinte padrão:
docs-nomedaissue

Criação de novas features

Para a criação de novas features, siga os seguintes passos:

  1. Crie uma issue com o template de feature
  2. Insira labels que estejam relacionados com a issue criada
  3. Aguarde o feedback de algum mantenedor que irá validar a feature sugerida
  4. Caso o feedback for positivo, dê assign da issue para você mesmo
  5. Inicie o desenvolvimento
  6. No pull request, faça o link do pull request com a issue criada previamente
  7. Aguarde a resposta do pull request

Issues

Bugs

Caso encontre algum bug no projeto, sinta-se à vontade para criar uma issue nos reportando:

  1. Crie a issue seguindo o template de Reportar Bugs
  2. Insira labels que estejam relacionados com a issue criada
  3. Aguarde feedback de um mantenedor

Sugestões de melhoria

Caso tenha alguma sugestão de melhoria ou feature siga os seguintes passos:

  1. Crie a issue seguindo um dos templates disponíveis no campo de criação da issue
  2. Insira labels que estejam relacionados com a issue criada
  3. Aguarde feedback de um mantenedor
  4. Caso queira contribuir com a implementação, verifique os passos para a criação de novas features

Atribuição

Este documento é uma adaptação do artefato do projeto 2019.1-Ludum, acessado em 27 de novembro de 2019.