Como contribuir
Antes de começar, obrigado por considerar contribuir com o Ro-DOU. acreditamos que a colaboração é essencial para construir soluções públicas mais eficientes, transparentes e sustentáveis.
o ro-DOU é um projeto open-source desenvolvido pelo Ministério da Gestão e da Inovação em Serviços Públicos com o propósito de de facilitar as extrações de dados D.O.U tanto para a administração pública quanto para a sociedade. Toda contribuição, seja código, documentação, ideias ou feedback, é bem-vinda.
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 git@github.com:gestaogovbr/Ro-dou.git
- crie uma nova branch
Recomendamos criar uma branch com um nome descritivo, como ajuste-na-documentacao ou feature-de-uma-nova-funcionalidade:
git checkout -b minha-branch
2 . faça suas alterações
contribuições podem incluir:
-
melhorias no código, nos testes
-
ajustes, correções ou acréscimos na documentação
-
sugestões de novas funcionalidades
-
correção de erros
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.
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 devem 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 a organização da discussão.
📝 Commits
As mensagens de commit devem seguir um padrão pré-definido, com prefixos como:
feat:para novas funcionalidades;fix:para correções de bugs;docs:para alterações na documentação;chore:para mudanças relacionadas a workflows do github;refactor:para melhorias no código e refatoração que não alteram o comportamento;test:para criação de novos testes ou melhorias nos testes já existentes.
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.
📧 Contato
Caso deseje expressar outros comentários, críticas, dúvidas ou sugestões, contate-nos.