Skip to content

chore: remove documentação e sondas internas do repositório - #5

Open
andrenfe wants to merge 1 commit into
masterfrom
chore/remove-internal-docs
Open

andrenfe wants to merge 1 commit into
masterfrom
chore/remove-internal-docs

Conversation

@andrenfe

Copy link
Copy Markdown
Member

Descrição

Remove do repositório a documentação e as ferramentas internas usadas na construção do v0.1:

  • openspec/: desenho e tarefas do v0.1 (18 arquivos);
  • docs/contrato/: decisões, sondas ao vivo e revisão interna (5 arquivos);
  • scripts/probes/: scripts das sondas ao vivo, que dependem de credenciais e de uma empresa de teste (8 arquivos).

As três pastas passam a ser ignoradas pelo git. Continuam disponíveis localmente para quem mantém o SDK, e o OpenSpec segue funcionando na máquina de quem o usa. O contrato provado continua coberto pelos testes do repositório: unitários, fixtures com corpos de erro reais e testes ao vivo opt-in em tests/live/.

Ajustes que acompanham a remoção:

  • CONTRIBUTING.md: inferências sobre o contrato passam a ser registradas na descrição do PR, e não mais em docs/contrato/.
  • pyproject.toml: o ruff deixa de excluir scripts/probes, que não existe mais no repositório.
  • tests/fixtures/error-envelopes.json: a descrição da origem dos corpos de erro não cita mais um caminho removido.

Os arquivos continuam acessíveis no histórico dos commits anteriores. O histórico não foi reescrito, para preservar a tag v0.1.0, a atestação do pacote no PyPI e a Release.

Tipo de mudança

  • feat
  • fix
  • docs
  • chore

Verificação

  • ruff check e ruff format --check: OK
  • pytest: 392 passaram, 13 pulados (testes ao vivo opt-in)
  • uv build: o sdist não contém nenhum arquivo das pastas removidas
  • Nenhum workflow de CI referencia as pastas removidas

Riscos/Impactos

  • Nenhuma mudança de código ou de comportamento do pacote.

openspec/, docs/contrato/ e scripts/probes/ passam a ficar só localmente
(ignorados pelo git). O contrato provado continua coberto pelos testes.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant