Skip to content

Bring repository to full SidOS SDLC Contract v1 compliance #16

Description

@sjayanna

Goal

Bring this repository to 100% compliance with the SidOS SDLC Contract v1.

The completed repository must run:

sid repo audit

with:

  • 0 failures
  • 0 warnings
  • all checks passing

Required Work

Inspect the repository and implement every missing contract requirement.

Expected areas include:

  • canonical AGENTS.md
  • SidOS Agent Contract: v1
  • all canonical AGENTS sections
  • thin CLAUDE.md delegation
  • appropriate .gitignore
  • accurate README.md
  • executable bin/validate
  • docs/README.md
  • docs/architecture.md
  • docs/design/
  • docs/decisions/
  • docs/operations/
  • docs/plans/
  • GitHub Actions workflow directly invoking bin/validate

Begin by running:

sid repo audit
sid repo repair --plan

Use those results to determine the repository-specific scope.

Documentation Requirements

Do not create empty, generic, misleading, or invented documentation merely to satisfy the audit.

Documentation must accurately describe:

  • repository purpose
  • repository responsibilities
  • architecture and boundaries
  • development workflow
  • testing and validation
  • operational procedures
  • important design constraints
  • durable engineering decisions
  • active plans, where applicable

Implementation Rules

  • Keep the PR focused on SDLC Contract v1 compliance.
  • Preserve meaningful repository-specific instructions.
  • Do not change application behavior unless necessary for reliable validation.
  • Reuse existing commands and conventions.
  • Make bin/validate the full-validation entrypoint.
  • Ensure CI invokes bin/validate directly.
  • Do not introduce unrelated refactoring.
  • Do not merge automatically.

Validation

Before opening the PR, run:

sid repo repair --plan
sid repo audit
bin/validate
git diff --check

Acceptance Criteria

  • sid repo audit reports 0 failures and 0 warnings
  • AGENTS.md complies with Agent Contract v1
  • CLAUDE.md delegates to AGENTS.md
  • .gitignore exists and is appropriate
  • README.md accurately describes the repository
  • bin/validate exists, is executable, and passes
  • CI directly invokes bin/validate
  • All required documentation paths exist
  • Documentation accurately reflects the repository
  • No unrelated application changes are included
  • A focused PR is opened and left unmerged

Umbrella

Part of sjayanna/sidos-cli#179

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions