Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
181 lines (123 loc) · 5.23 KB

CONTRIBUTING.md

File metadata and controls

181 lines (123 loc) · 5.23 KB
Raw

🤝 Guia de Contribuição — envguard

Primeiramente, muito obrigado por dedicar seu tempo para contribuir com o envguard! 🎉
Projetos de código aberto são feitos por e para a comunidade, e toda a contribuição — seja corrigindo um bug, sugerindo uma funcionalidade, melhorando a documentação ou escrevendo testes — é muito bem-vinda.

Sumário

Código de Conduta

Ao participar deste projeto, você concorda em cumprir o nosso Código de Conduta. Esperamos que todos os participantes mantenham um ambiente respeitoso, inclusivo e seguro para todos.

Como Contribuir?

Reportando Bugs

Se você encontrou um comportamento inesperado ou erro:

  1. Verifique na aba Issues se o problema já foi reportado.
  2. Caso não exista, abra uma nova issue com:
  • Uma descrição clara do problema.
  • Passos para reproduzir o erro.
  • Sistema operacional e versão do Go/envguard.
  • Logs ou mensagens de erro relevantes (certifique-se de não incluir credenciais reais nos logs!).

Sugerindo Melhorias

Ideias para novas funcionalidades são muito bem-vindas!

  1. Abra uma issue detalhando a motivação da sugestão e como ela beneficiaria os usuários.
  2. Descreva cenários de uso ou propostas de interface na CLI.

Contribuindo com Código

Se deseja resolver uma issue ou adicionar uma funcionalidade:

  1. Comente na issue em que deseja trabalhar para alinharmos e evitarmos retrabalho com outros contribuidores.
  2. Siga as diretrizes de desenvolvimento abaixo.

Ambiente de Desenvolvimento

Pré-requisitos

  • Go versão 1.22 ou superior.
  • Git instalado.

Configurando o Repositório Localmente

# 1. Faça um Fork do repositório no GitHub para sua conta

# 2. Clone o seu fork
git clone https://github.com/<seu-usuario>/envguard.git
cd envguard

# 3. Adicione o repositório upstream oficial
git remote add upstream https://github.com/joaooncode/envguard.git

# 4. Baixe as dependências do módulo Go
go mod download

Comandos Úteis

# Executar a CLI em desenvolvimento
go run ./cmd/envguard scan

# Executar a suíte de testes automatizados
go test ./...

# Executar testes com cobertura
go test -cover ./...

# Compilar o binário localmente
go build -o envguard ./cmd/envguard

Padrões de Código e Qualidade

Para manter a consistência em todo o projeto:

  1. Formatação Oficial do Go:
  • Execute sempre o gofmt antes de comitar: 
    gofmt -s -w .
  1. EditorConfig & Prettier:
  • O projeto possui .editorconfig e .prettierrc configurados.
  • Mantenha Tabs para arquivos Go e 2 espaços para Markdown, YAML e JSON.
  1. Segurança em Primeiro Lugar:
  • Regra fundamental: O envguard nunca deve imprimir nem expor valores de variáveis de ambiente ou segredos detectados.

Convenção de Commits (Conventional Commits)

Utilizamos o padrão Conventional Commits para manter o histórico claro e possibilitar a automação de releases.

Formato: <tipo>(<escopo opcional>): <descrição no imperativo>

Tipos permitidos:

  • feat: Nova funcionalidade.
  • fix: Correção de bug.
  • refactor: Refatoração sem alteração de comportamento externo.
  • perf: Melhoria de desempenho.
  • docs: Alterações ou adições na documentação.
  • style: Formatação, linting ou imports (sem alteração de lógica).
  • test: Criação ou atualização de testes automatizados.
  • chore: Atualização de dependências, builds ou configurações gerais.

Exemplos:

git commit -m "feat(scanner): implementar detecção recursiva de arquivos .env"
git commit -m "fix(git): tratar repositórios sem commits iniciais"
git commit -m "docs: adicionar guia de instalação no README"

Fluxo de Pull Requests

  1. Mantenha sua branch sincronizada com a upstream: 
    git checkout main
git fetch upstream
git merge upstream/main
  2. Crie uma branch local descritiva para a sua tarefa: 
    git checkout -b feat/minha-nova-feature
  3. Implemente as alterações com testes:
  • Adicione testes unitários para o código novo/corrigido.
  • Certifique-se de que go test ./... está passando.
  1. Envie para o seu fork: 
    git push origin feat/minha-nova-feature
  2. Abra o Pull Request:
  • Abra o PR apontando para a branch main do repositório oficial.
  • Preencha os campos do nosso Pull Request Template (.github/pull_request_template.md) com clareza.
  • Marque a checklist pré-envio.

Muito obrigado por ajudar a tornar o envguard cada vez melhor e mais seguro!