Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 3.82 KB

CONTRIBUTING.pt-br.md

File metadata and controls

73 lines (53 loc) · 3.82 KB
Raw

Contribuindo com VSS Simulation 🚀

Primeiramente, obrigado pelo interesse! Nós agradecemos muito pela participação da comunidade nesse projeto! ✨

Esse documento descreve um conjunto de diretrizes para contribuir com esse projeto. Não são regras estritas, então sempre vale o bom senso, e, em caso de dúvidas, nos contate em comp@thunderatz.org.

Por favor, note que este projeto é liberado com um Código de Conduta para Colaboradores. Ao participar deste projeto, você concorda em cumprir seus termos.

Como eu posso contribuir?

Issues

A maior parte das contribuições é feita por meio de GitHub Issues. Elas serão usadas principalmente para

  1. Identificar bugs - bug
  2. Sugerir melhorias e recursos - enhancement
  3. Melhorar a documentação - documentation

Para cada um desses itens, existe um label específico. Nós recomendamos fortemente que todas as issues criadas contenham pelo menos um desses labels descritos a cima.

Mas, antes de criar uma nova issue, é importante primeiro checar se já não existe uma com o mesmo assunto. Você pode filtrar por labels, por exemplo, aqui serão mostradas apenas as issues ativas com o label bug.

Identificando bugs 🐛

  • Use títulos claros
  • Especifique a versão do pacote
  • Especifique o SO, MV (se aplicável), pacotes instalados, e outras configurações que podem ser úteis.
  • Descreva os passos para reproduzir o bug encontrado
  • Descreva o comportamento observado e o esperado
  • Inclua screenshots, gifs e outros tipos de referências que podem ajudar a explicar o problema

Sugerir melhorias e recursos ✨

  • Use títulos claros
  • Descreva a sugestão passo-a-passo
  • Descreva o comportamento esperado após implementar a ideia
  • Explique por que esse novo recurso ou atualização pode ser útil

Melhorar a documentação 📝

  • Use títulos claros
  • Especifique os arquivos que precisam ser documentados
  • Explique suas sugestões e por que seriam melhores ou mais claras

Pull Requests

Se você quiser contribuir com código para o projeto, procure uma issue e comece a desenvolver sua solução! Quando você estiver pronto, abra uma Pull Request e nós vamos revisar.

Algumas recomendações:

  • Descreva exatamente o que você fez e porque, sendo sempre o mais claro possível
  • Adicione o link com a issue correspondente ao seu Pull Request (se não houver nenhuma, por favor crie uma nova)
  • Confira se você está seguindo o Syleguide

Styleguide 💄

O código e a estrutura devem seguir ROS Use Patterns e ROS Best Practices.

Python

Todo código em python deve seguir os guias ROS Python e PEP 8.

Menssagens de commit

  • As menssagens devem ser escritas preferencialmente em inglês.

  • Use o tempo presente ("Add feature" não "Added feature")

  • Use o modo imperativo ("Move cursor to..." não "Moves cursor to...")

  • Nós recomendamos fortemente iniciar a menssagem de commit com um emoji relacionado

    • 📝 :memo: para documentação
    • 🐛 :bug: para bugs
    • 🚑 :ambulance: para correções críticas
    • 🎨 :art: para melhorias na estrutura
    • ✨ :sparkles: para novos recursos

    Para mais exemplos, veja aqui.

Fluxo de trabalho

O fluxo de trabalho é baseado no Git Flow.

Documentação

A documentação é gerada com Doxygen e deve seguir o seu manual de documentação.