Skip to content

Latest commit

 

History

History
102 lines (76 loc) · 4.64 KB

CONTRIBUTING.md

File metadata and controls

102 lines (76 loc) · 4.64 KB

Contribuindo para JoyVoice Board

A seguir há uma lista de diretrizes para contribuir com o projeto. São regras e recomendações para facilitar o entendimento da sua contribuição. Lembre-se de ser descritivo e fique a vontade para fazer um pull request.

Sumário

Formas de contribuir

Guia para contribuir

Padrões

Formas de contribuir

Reportando Bugs

Se você encontrou algum bug, crie uma issue utilizando a label bug.

Se estiver inspirado, pode fazer um pull request corrigindo o erro. :)

Só não esqueça de referenciar a issue criada, para que possamos saber qual o problema você está resolvendo com aquele pull request.

Implementando Melhorias

Há uma lista de issues que você pode resolver. Além disso, na documentação do projeto há mais tarefas a serem desenvolvidas.

Atenção:

  • Se for uma Issue, adicione a label em progresso.
  • Se for uma tarefa na documentação do projeto, mova-a para a coluna 'Fazendo'.

Sugerindo Melhorias

Acha que falta alguma coisa no projeto? Viu algo que pode ser melhorado?

Crie uma issue, utilizando a label melhoria, e informe sua sugestão.

Guia para contribuir

1. Faça um Fork do projeto

Para poder trabalhar na função sem atrabalhar outros contribuíntes, faça um fork do projeto.

(TODO: Imagem ilustrativa)

2. Crie uma branch para a sua contribuição.

A partir da branch mais recente do desenvolvimento, crie a branch da sua função ou melhoria. O nome da branch deve refletir o que será adicionado.

Por exemplo:

  • feat/tocar_som
  • hotfix/remover_delay

Para um referência melhor sobre branches, acesse esse link.

3. Faça os devidos commits

Adicione sua contribuição através de commits na sua nova branch. Não se sequeceça de usar o padrão de mensagens de commit

4. Faça um Pull Request para o repositório.

Ao criar um Pull Request, você deve descrever bem aquilo que foi adicionado, pontuando o que está sendo resolvido e como está sendo resolvido.

Quanto mais descrição, melhor ;)

Pronto!

Sua contribuição já está em revisão e será analisada pelo nosso time.

Muito obrigado!

Padrões

Mensagens de Commit

  • Use o tempo presente ("Adiciona função..." e não "Adicionei função...")

  • Não coloque ponto final (.)

  • Deve-se utilizar prefixos antes de todo commit.

  • Prefixos:

    • feat : Nova função
    • fix : Resolução de bugs
    • docs : Mundanças em documentação
    • style : Formatação do código (ex. identar, remover linhas em branco)
    • refactor : Refatoração de código em produção (ex. renomear variável)
    • test : Adição de testes
    • clean : Remoção de código morto/arquivos
    • chore : Mudanças em arquivos de desenvolvimento, sem mudanças em código de produção.

    *Obs: Os prefixos estão em inglês por conta da pouca quantidade de caracteres utilizada.

    Exemplos:

    • feat: adiciona botão iniciar
    • fix: corrige erro na conversão do valor
    • docs: adiciona sessão 'Contribuição' no README.md
    • style: corrige identação da classe 'Soundboard'.
    • refactor: renomeia varáveis da classe 'Efeito'.
    • test: cria teste de tocar som.
    • clean: remove arquivo 'teste.py'
    • chore: adiciona pasta no .gitignore

Pull Requests

Ao fazer um pull request, deve-se atentar para a branch a qual você quer mesclar, e também qual issue você está resolvendo.

Você pode (e deve) fazer um pull request (PR) referenciando uma issue. Para isso deve-se adicionar o id da issue (#). Isso pode ser feito tanto no título do PR, quanto na descrição.

Exemplo:

  • Resolve problema da issue #20
  • Adiciona a função xxxx ref #9

Outro ponto importante é utilizar as labels apropriadas.

Labels

As labels disponíveis para utilização estão aqui.