Pular para conteúdo

Guia de Contribuição

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

  1. 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.