Contribuindo — Rede Cívica Docs
Este arquivo descreve o fluxo de contribuição do repositório. As regras de escrita e de sincronização estão no AGENTS.md e valem integralmente.
Antes de começar
Seção intitulada “Antes de começar”- Leia o
AGENTS.mddeste repositório por inteiro. - Leia o compilado e o contexto_IA.md.
- Leia o SDS da área afetada, quando a mudança tocar implementação.
- Entenda o escopo: os textos conceituais e legais (rede_civica.md, contexto_IA.md e politica_privacidade.md) são mantidos pelo autor do projeto. Contribuições externas ficam no escopo técnico: sds/, deploy.md e correções de documentação.
Fluxo de contribuição
Seção intitulada “Fluxo de contribuição”- Issue primeiro. Abra uma issue descrevendo o problema ou a proposta. Mudança sem issue anterior pode ser rejeitada.
- Fork. Faça fork do repositório para sua conta.
- Branch. Crie uma branch a partir de
master. Nome em inglês kebab-case, com o escopo do documento. Ex.:fix/taxonomia-d-3,docs/governanca-parametros. - Commits. Conventional Commits em português, com escopo do documento. Ex.:
docs(d-3): corrigir nota de roteamento. Commits atômicos. - CLA. Aceite o Contributor License Agreement no pull request. O CLA Assistant pede o aceite no primeiro PR. O contrato está em
CLA.md. O aceite cobre as contribuições presentes e futuras. Pull request sem aceite não entra. - Pull request. Preencha o template da org e descreva o que mudou e por quê.
- Gates. Os checks do CI precisam passar. Rode
npm run verificarem local antes de abrir o PR. - Revisão. Um mantenedor revisa e aprova. O merge acontece depois da aprovação e dos checks verdes.
Gates de qualidade
Seção intitulada “Gates de qualidade”O CI roda markdownlint e verificação de links. Em local, os mesmos checks rodam com:
npm run verificarA sincronização dos parâmetros públicos e da política de privacidade é conferida na revisão da leva, conforme o AGENTS.md.
Enquanto os repositórios da org não estiverem públicos, os links para github.com/Rede-Civica/... ficam na lista de exceção do verificador (.markdown-link-check.json). A exceção sai na leva de publicação.
Regras de escrita
Seção intitulada “Regras de escrita”- Siga o estilo do
AGENTS.md: frases curtas, tom neutro, sem travessão retórico e sem clichê. - Nomes de arquivo em português, descritivos, com extensão
.md. - O compilado é a fonte da verdade. O
contexto_IA.mdacompanha na mesma leva. - Não contradiga outras partes do compilado. Conflito se sinaliza na issue antes de aplicar.
Parâmetros públicos
Seção intitulada “Parâmetros públicos”Parâmetros de negócio têm dois espelhos públicos: o Apêndice C de rede_civica.md e public/public-parameters.json do repo mvp-web. Mudança de parâmetro exige atualização dos dois espelhos na mesma leva. Divergência entre código e documento é defeito.
Política de privacidade
Seção intitulada “Política de privacidade”O texto canônico é politica_privacidade.md. O aplicativo mantém o espelho em repos/web/src/lib/lgpd/politica-privacidade.ts. Mudança no texto canônico exige atualizar o espelho, com elevação da versão do termo quando a mudança afetar o consentimento.
Código de conduta
Seção intitulada “Código de conduta”A convivência segue o código de conduta da org, publicado no repo .github da Rede-Civica.