Obrigado por seu interesse em contribuir para este projeto! Sua ajuda é muito importante para que possamos melhorar continuamente. Este guia irá explicar, passo a passo, como você pode colaborar de forma eficiente.

1. Reportando problemas (Issues)

Se você encontrar algum problema, erro ou tiver uma sugestão de melhoria, abra uma issue no repositório.
  • Descreva o problema claramente.
  • Inclua passos para reproduzir o erro, se aplicável.
  • Adicione informações do seu ambiente (sistema operacional, versão, etc).
  • Se possível, sugira uma solução.

2. Fazendo contribuições (Pull Requests)

Se quiser ajudar com código, documentação ou outras melhorias, siga os passos abaixo:

Passo 1: Faça um fork do repositório

No GitHub, clique no botão Fork para criar uma cópia do projeto na sua conta.

Passo 2: Clone o seu fork localmente

git clone https://github.com/seu-usuario/nome-do-repositorio.git
cd nome-do-repositorio

Passo 3: Crie uma branch para sua feature ou correção

git checkout -b minha-nova-feature

Passo 4: Crie uma branch para sua feature ou correção

  • Adicione código, correções ou melhorias na documentação.
  • Certifique-se de seguir o padrão do projeto e o estilo de código existente.

Passo 5: Commit das alterações

git add .
git commit -m "feat: descreva sua mudança aqui"
Use mensagens de commit claras, como feat, fix, docs etc

Passo 6: Envie sua branch para o seu fork

git push origin minha-nova-feature

Passo 7: Abra um Pull Request (PR)

  • Vá para o seu fork no GitHub.
  • Clique em Compare & pull request.
  • Explique o que você alterou e por quê.
Marque os revisores se necessário e envie o PR.
Dicas extras
  • Sincronize seu fork com o repositório original regularmente ‘(git pull upstream main)’ para evitar conflitos.
  • Revise seu código antes de enviar o PR.
  • Para documentação, verifique ortografia e formatação.