Obrigado por considerar contribuir para o projeto Validator! Este guia irá ajudá-lo a colaborar de maneira eficiente e produtiva.
Se você encontrou um bug, tem uma dúvida ou gostaria de sugerir uma nova funcionalidade:
- Verifique se o problema já foi relatado navegando nos issues existentes.
- Abra um novo issue com o máximo de detalhes possível, incluindo:
- Descrição clara do problema.
- Passos para reproduzir o erro, se aplicável.
- Ambiente (versão do Go, sistema operacional, etc.).
- Mensagens de erro relevantes ou logs.
Se você deseja corrigir um problema ou implementar uma nova funcionalidade:
- Faça um fork do repositório.
- Crie um novo branch com um nome descritivo:
git checkout -b fix/validacao-email
- Faça suas alterações e adicione commits significativos:
- Escreva mensagens de commit claras e descritivas.
- Certifique-se de que os testes estejam passando:
go test ./...
- Abra um pull request para o branch
main
, explicando:- O problema que você está resolvendo.
- Uma descrição das mudanças feitas.
- Qualquer contexto adicional que ajude na revisão.
- Clone o repositório:
git clone https://github.com/Marlliton/validator.git cd validator
- Certifique-se de ter o Go instalado (versão mínima recomendada: (1.23.4).
- Instale dependências, se necessário:
go mod tidy
- Rode os testes para garantir que tudo está funcionando:
go test ./...
- Todo código novo deve incluir testes apropriados. Isso garante que as alterações sejam verificáveis e que o projeto mantenha sua qualidade.
- Os testes devem ser colocados no mesmo diretório do arquivo que está sendo testado seguido de
*_test.go
. - Siga o padrão de nomenclatura e organização dos testes existentes.
- Este projeto segue as práticas recomendadas da comunidade Go (verifique o Effective Go).
- Use o
gofmt
para formatar seu código:gofmt -s -w .
- Nomeie variáveis, funções e métodos de forma clara e descritiva.
- Mantenha os pull requests pequenos e focados. Grandes alterações são mais difíceis de revisar.
- Explique suas mudanças claramente no PR.
- Sempre atualize seu branch com as últimas alterações do branch principal:
git pull origin main
Se você tiver alguma dúvida sobre como contribuir, abra um issue ou entre em contato diretamente pelo repositório.