Pular para conteúdo

3. Como Contribuir

Ficamos muito felizes com seu interesse em contribuir com o PixCore! Toda contribuição, não importa o tamanho, é bem-vinda e valorizada.

Este guia fornecerá tudo que você precisa para começar a colaborar com o projeto, seja reportando um bug, sugerindo uma nova funcionalidade ou escrevendo código.

Tipos de Contribuição

Existem muitas maneiras de contribuir, e todas são importantes:

  • 🐞 Reportando Bugs: Se você encontrou um comportamento inesperado ou um erro, abra uma Issue detalhando o problema.
  • 💡 Sugerindo Melhorias ou Novas Funcionalidades: Tem uma ideia para tornar o PixCore ainda melhor? Adoraríamos ouvi-la! Crie uma Issue para descrever sua sugestão.
  • 📖 Melhorando a Documentação: Se você encontrou um erro de digitação, uma explicação confusa ou acredita que uma seção pode ser melhorada, sinta-se à vontade para propor alterações.
  • 💻 Escrevendo Código: Você pode corrigir um bug existente ou implementar uma nova funcionalidade.

Configurando o Ambiente de Desenvolvimento

Para garantir que você tenha um ambiente de desenvolvimento limpo e consistente, o projeto utiliza Poetry para gerenciar dependências e ambientes virtuais.

Siga os passos abaixo para configurar seu ambiente local:

  1. Faça um Fork do Repositório Clique no botão "Fork" no canto superior direito da página do repositório no GitHub.

  2. Clone o seu Fork Em seu terminal, clone o repositório que você acabou de "forkar": bash git clone [https://github.com/gustjose/pixcore.git](https://github.com/gustjose/pixcore.git) cd pixcore

  3. Instale as Dependências com Poetry Se você ainda não tem o Poetry, siga as instruções de instalação. Com o Poetry instalado, execute o comando abaixo para instalar todas as dependências do projeto, incluindo as de desenvolvimento (pytest, black, etc.): bash poetry install

  4. Ative o Ambiente Virtual Para ativar o ambiente virtual gerenciado pelo Poetry, utilize o comando: bash poetry shell Agora você está pronto para começar a codificar!

Fluxo de Trabalho para Contribuição de Código

  1. Crie uma Nova Branch Sempre trabalhe em uma nova branch para manter o histórico organizado. Escolha um nome descritivo para ela.
# Exemplo para uma nova funcionalidade
git checkout -b feature/adiciona-suporte-a-campo-x

# Exemplo para uma correção de bug
git checkout -b fix/corrige-calculo-crc16

  1. Escreva seu Código Faça as alterações ou adições necessárias no código. Lembre-se de seguir o estilo e a arquitetura existentes.

  2. Garanta a Qualidade do Código Antes de submeter sua contribuição, rode as ferramentas de qualidade para formatar e verificar seu código.

task lint
  1. Execute os Testes É fundamental que todos os testes passem antes de você criar um Pull Request. Adicione novos testes se você estiver implementando uma nova funcionalidade.
task test
  1. Envie seu Pull Request (PR) Após fazer o commit das suas alterações, envie-as para o seu fork e abra um Pull Request para a branch main do repositório original.
git push origin nome-da-sua-branch

Ao abrir o PR, forneça um título claro e uma descrição detalhada do que foi feito. Se sua alteração resolve uma Issue existente, mencione-a na descrição (ex: Resolve #123).

Código de Conduta

Embora ainda não tenhamos um arquivo formal de Código de Conduta, pedimos que todas as interações neste projeto (issues, pull requests, etc.) sejam feitas de forma respeitosa, construtiva e amigável.

Obrigado por dedicar seu tempo e talento ao PixCore!