IntentGuard

E01 — Project foundation and reproducibility

Planning / historicalumbrelladelivery

Historical

Planning material. It summarizes and links to the authoritative specification and the current measured state — it does not replace either, and it is not current engineering truth.

Migration identity#

  • Canonical identifier: E01 (GitHub issue type: epic).
  • Legacy identifier: U01 (retained as old_identifier).
  • Parent umbrella: W01.
  • Milestone: M1 — IntentGuard Weekend MVP.

Objective#

Establish repository governance, Python 3.11 packaging, locked dependencies, reviewed configuration, command contracts, foundation tests, and CPU CI.

Rationale#

Every later result depends on a repeatable environment and an honest command surface; this removes setup ambiguity before ML work begins.

Parent identifier#

Umbrella issue W01 in milestone M1 — IntentGuard Weekend MVP.

Source task#

T-001.

Traceability#

Primary: T-001, FR-010, NFR-003, NFR-007, NFR-008. No numbered AC has primary ownership here; U01 establishes their execution substrate.

Prerequisites#

Approved Gate A plan, MIT confirmation, Python 3.11, and uv.

Likely files#

AGENTS.md, CLAUDE.md, README.md, LICENSE, pyproject.toml, uv.lock, Makefile, .gitignore, .env.example, configs/default.toml, src/intentguard/__init__.py, src/intentguard/config.py, scripts/validate_foundation.py, skeleton tests, .github/.

Implementation boundary#

Foundation only. Do not implement data, model, evaluation, API, or demo behavior and do not let future targets exit successfully.

MUST scope#

S01.1 governance/skeleton; S01.2 packaging/lock/config; S01.3 Make/CI/collaboration and validation scaffolding.

Explicit non-goals#

ML application behavior, downloaded data, trained artifacts, Docker, deployment, extra tooling, or GPU claims.

Acceptance criteria#

The package imports; configuration parses; the lock validates and installs; required files/targets exist; unimplemented commands fail; Ruff, mypy, foundation validation, pytest, and CPU CI are truthfully configured.

Validation commands#

uv lock --check && make setup && make help && make lint && make test.

Expected evidence#

uv.lock, clean command outputs, foundation-test results, parsed manifests, and a CPU workflow referencing only existing checks.

Fallback and status consequence#

An unlocked or partial environment makes U01 Partial and blocks strict MVP. CPU-only validation is Implemented for this umbrella; it creates no GPU compatibility claim.

Stop condition#

Stop for unapproved dependencies, overwritten user files, secrets, unavailable Python 3.11, lock/install failure, or any required Git/GitHub mutation.

Definition of ready#

Dependencies and boundaries are justified by the specification; Gate A is approved; no conflicting existing foundation exists.

Definition of done#

S01.1–S01.3 pass their validations and the repository reports the actual foundation status without claiming ML completion.

Labels#

type:epic, priority:MUST, area:foundation

Estimate#

1.0 hour.

Related in repository

Open in full graph →
DOCUMENTED_BY — source: docs/backlog/umbrellas/U01-project-foundation.md § E01 — Project foundation and reproducibilityREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.mdREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.mdREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.mdREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.mdREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.mdREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.mdREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.mdREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.mdREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.mdPART_OF — source: docs/backlog/TRACEABILITY.md § Source tasksPART_OF — source: docs/backlog/TRACEABILITY.md § Functional requirementsPART_OF — source: docs/backlog/TRACEABILITY.md § Non-functional requirementsREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.md § TraceabilityREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.md § TraceabilityREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.md § TraceabilityREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.md § TraceabilityREFERENCES — source: docs/backlog/umbrellas/U01-project-foundation.md § TraceabilityPART_OF — source: docs/backlog/TRACEABILITY.md § Functional requirementsREFERENCES — source: docs/backlog/tasks/C01.2-python-packaging-lock-config.md § TraceabilityREFERENCES — source: docs/backlog/tasks/C01.3-make-ci-collaboration.md § TraceabilityPART_OF — source: docs/backlog/TRACEABILITY.md § Non-functional requirementsREFERENCES — source: docs/backlog/tasks/C01.2-python-packaging-lock-config.md § TraceabilityPART_OF — source: docs/backlog/TRACEABILITY.md § Non-functional requirementsREFERENCES — source: docs/backlog/tasks/C01.1-agent-instructions-skeleton.md § TraceabilityPART_OF — source: docs/backlog/TRACEABILITY.md § Non-functional requirementsREFERENCES — source: docs/backlog/tasks/C01.2-python-packaging-lock-config.md § TraceabilityPART_OF — source: docs/backlog/TRACEABILITY.md § Source tasksREFERENCES — source: docs/backlog/tasks/C01.1-agent-instructions-skeleton.md § TraceabilityCURRENTdocument: E01 — Project foundation and reproducibilityE01epic: E01FR-010 — Reproducible co…requirement: FR-010 — Reproducible commandsNFR-003 — Reproducibilityrequirement: NFR-003 — ReproducibilityNFR-007 — Maintainabilityrequirement: NFR-007 — MaintainabilityNFR-008 — Dependency con…requirement: NFR-008 — Dependency controlS01.1task: S01.1S01.2task: S01.2S01.3task: S01.3T-001 — Locked validated…task: T-001 — Locked validated repository skeleton
Hover an edge for its provenance · click a node to open it10 nodes · 29 edges