Guia de Contribuição

Antes de começar, obrigado por considerar contribuir com o Gov Hub BR. acreditamos que a colaboração é essencial para construir soluções públicas mais eficientes, transparentes e sustentáveis.

o gov hub br é um projeto open-source com o propósito de transformar dados públicos em ativos estratégicos para a administração pública e a sociedade. toda contribuição, seja código, documentação, ideias ou feedback, é bem-vinda.

Como contribuir¶

1 faça um fork do repositório

Clique em "fork" no canto superior direito da página do projeto e clone o repositório no seu ambiente local:

git clone https://github.com/seu-usuario/govhub-br.git

crie uma nova branch

recomendamos criar uma branch com um nome descritivo, como ajuste-na-doc ou feature-nova-transformacao:

git checkout -b minha-contribuicao

2 . faça suas alterações

contribuições podem incluir:

melhorias no código ou em pipelines de dados
ajustes ou acréscimos na documentação
sugestões de novas funcionalidades
correção de erros ou inconsistências

teste e valide sua contribuição

sobre o pull request

Antes de enviar, certifique-se de que sua alteração está funcionando corretamente, sem quebrar funcionalidades existentes, e que segue os padrões definidos pelo projeto.

Envie um pull request utilizando o modelo disponível no repositório. isso ajuda a equipe a entender rapidamente o contexto da sua contribuição e agiliza o processo de revisão.

Suba sua branch para o seu fork e abra um pull request direcionado ao repositório principal. descreva de forma objetiva o que foi alterado, por que essa mudança é necessária e, sempre que possível, inclua prints, logs ou links relacionados.

📌 Abertura de Issues¶

Toda solicitação de mudança, correção de bug ou sugestão de melhoria deve ser registrada por meio de uma issue. As issues devem ser abertas utilizando o modelo padrão fornecido pelo repositório, o qual ajuda a manter a clareza, rastreabilidade e organização da discussão. Certifique-se de preencher todos os campos obrigatórios com informações precisas, como contexto, impacto e possíveis caminhos de solução.

📝 Commits¶

As mensagens de commit devem seguir um padrão pré-definido, inspirado no Conventional Commits, com prefixos como:

feat: para novas funcionalidades;
fix: para correções de bugs;
docs: para alterações na documentação;
ci: para mudanças relacionadas a integração contínua;
refactor: para melhorias no código que não alteram comportamento.

Cada mensagem de commit deve conter uma descrição clara, objetiva e sucinta da mudança implementada. Quando necessário, utilize a descrição estendida do commit para detalhar motivações, impactos e decisões técnicas importantes. Isso facilita o entendimento histórico das mudanças e contribui para uma base de código mais sustentável e auditável.

🤝 Convivência, respeito e ética na colaboração¶

A colaboração neste repositório deve sempre ocorrer em um ambiente de respeito mútuo, empatia e abertura ao diálogo. Espera-se que todas as interações — sejam em issues, pull requests, revisões de código ou discussões técnicas — sejam conduzidas com educação, cordialidade e espírito colaborativo. Críticas devem ser construtivas, com foco na solução e na melhoria contínua, nunca direcionadas de forma pessoal.

Não será tolerado nenhum tipo de discurso ou comportamento ofensivo, discriminatório, agressivo ou de ódio. Isso inclui, mas não se limita a: racismo, sexismo, homofobia, xenofobia ou qualquer outra forma de preconceito. A manutenção de um ambiente saudável, inclusivo e profissional é responsabilidade de todos os colaboradores e condição essencial para a participação neste projeto.

Contribuir com respeito é tão importante quanto contribuir com código.