Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
137 lines (97 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

137 lines (97 loc) · 3.38 KB

Guia de Contribuição

Obrigado por contribuir com os repositórios da organização.

Este documento define as regras mínimas para criação, alteração, revisão e publicação de código. O objetivo é garantir organização, rastreabilidade, segurança e facilidade de manutenção.

1. Quem pode contribuir

Podem contribuir:

  • membros autorizados da equipe responsável;
  • analistas e administradores vinculados ao processo;
  • colaboradores designados para manutenção ou evolução do código.

Toda contribuição deve seguir este guia e, quando aplicável, passar por revisão antes do merge.

2. Regras gerais

Antes de contribuir:

  • entenda o objetivo do script, rotina ou projeto;
  • evite alterações não relacionadas no mesmo commit;
  • mantenha commits pequenos e com propósito único;
  • documente o que foi alterado;
  • nunca envie credenciais, senhas, tokens ou segredos no código;
  • valide a alteração antes de abrir Pull Request;
  • respeite os padrões definidos pela organização.

3. Fluxo de contribuição

O fluxo recomendado é:

  1. atualizar sua cópia local da branch principal;
  2. criar uma branch para a alteração;
  3. implementar a mudança;
  4. testar localmente;
  5. revisar os arquivos modificados;
  6. criar commits claros;
  7. abrir Pull Request;
  8. aguardar revisão e aprovação;
  9. realizar merge somente após aprovação.

4. Estratégia de branches

Não trabalhe diretamente na main, salvo em situações excepcionais e autorizadas.

Padrão sugerido

feature/nome-da-mudanca
fix/nome-da-correcao
docs/atualizacao-readme
chore/padronizacao-repo
hotfix/correcao-urgente

5. Padrão de commit

Use commits pequenos, claros e com propósito único.

Modelo sugerido

tipo(escopo): descrição

Exemplos

feat(powershell): adiciona rotina de limpeza de logs
fix(sqlserver): corrige filtro de procedure de contratos
docs(repo): atualiza instruções de execução
chore(git): ajusta gitignore
refactor(python): separa autenticação em módulo próprio

6. Pull Request

Toda Pull Request deve conter contexto suficiente para revisão.

Inclua, sempre que possível:

  • objetivo da alteração;
  • tipo da mudança;
  • impacto esperado;
  • sistemas afetados;
  • como foi testado;
  • riscos conhecidos;
  • forma de rollback, quando aplicável.

7. Documentação obrigatória

Ao criar ou alterar código relevante, atualize a documentação correspondente.

O README.md deve responder, sempre que aplicável:

  • para que serve;
  • quem usa;
  • qual sistema afeta;
  • quais parâmetros recebe;
  • quais permissões exige;
  • como testar;
  • como desfazer ou interromper.

8. Segredos e dados sensíveis

É proibido versionar:

  • senhas;
  • tokens;
  • chaves privadas;
  • segredos de aplicação;
  • arquivos .env reais;
  • strings de conexão reais;
  • dumps de banco;
  • arquivos com dados sensíveis.

Utilize:

  • variáveis de ambiente;
  • cofres de segredo;
  • arquivos de exemplo, como config.example.json ou .env.example.

9. Alterações emergenciais

Para alterações urgentes:

  • use branch hotfix/...;
  • documente claramente o problema;
  • registre o impacto;
  • revise o mais rápido possível;
  • atualize a documentação após a correção;
  • garanta rastreabilidade da mudança.

10. Observações finais

Contribuir com os repositórios da organização significa preservar a qualidade, a segurança e a continuidade operacional.