Pular para conteúdo

Como contribuir com o knowledge-base

Duas camadas: quem escreve (autoria) e quem consome (leitura). Elas não se misturam.

Camada de autoria (mantenedores)

Só mantenedores escrevem. Sempre via Git, nunca editando direto na branch principal.

Fluxo: 1. git pull na main. 2. Crie uma branch: git checkout -b docs/<escopo>. 3. Edite seguindo as convenções do CLAUDE.md (frontmatter, referência a arquivos do Drive, placeholders de segredo). 4. Commit no padrão tipo(escopo): descrição — ex.: docs(omie): corrige mapping de produto. Tipos: docs, fix, refactor, chore. 5. Abra um Pull Request. Revisão antes do merge na main.

Regras de ouro: - Nunca commite segredo (chave, token, senha). Só placeholders; valores reais no Drive restrito. - Nunca coloque binário/dataset no repo. Vai pro Drive; referencie no ARQUIVOS.md. - Arquivo grande demais → quebre em módulos por tema (reduz conflito de merge). - Todo projeto novo começa com README.md + frontmatter válido.

Camada de consumo (o resto do time)

  • Acesso somente-leitura (clone com git pull, ou leitura via web/pasta conectada).
  • Quem consome não escreve. Tem uma correção ou ideia? Sugere via Claude, abre uma issue, ou avisa o mantenedor. Não edita direto.

Estrutura

Ver CLAUDE.md — organização por disciplina, anatomia de projeto e todas as convenções.