Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,5 @@ jobs:
node-version: "20"
- name: Validate SKILL.md frontmatter
run: node scripts/validate-skills.mjs
- name: Test local review harness
run: npm test
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,8 @@ evidence-bundle-*/
*.zip
*.mp4
.DS_Store

# Local review evidence and disposable run state
.review-runs/

__pycache__/
60 changes: 40 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
# code-qa

A small, project-agnostic suite of **agent skills that ensure shipped code is
properly reviewed, improved, and proven** — the verification & evidence gap that
off-the-shelf skills don't cover. Generation chores (code review summaries, commit
messages, READMEs, changelogs) are already commodified; the durable, under-served
value is *making sure what ships is correct and showing that it is*. These skills
encode that discipline.
A shared review procedure and local runner for mechanical checks, one Codex
reviewer, and isolated OpenELIS execution. It records the reviewed revisions,
findings, supporting evidence, usage and incomplete outcomes.

> Why this focus? Across the 2026 surveys, AI-generated changes still fail after
> passing QA, the majority need intervention, and most developers don't trust AI
> code without manual review. The bottleneck is verification, not generation.
The procedure starts with accepted requirements and component ownership. It
supports legitimate removal of obsolete code and tests. Reviews remain advisory;
recorded evidence does not guarantee that a change is correct.

## Skills

| Skill | What it does |
|---|---|
| **review-change** | Shared requirement, ownership and evidence procedure for general and targeted reviews. |
| **evidence-bundle** | Turn a Playwright/E2E run into a structured, shareable proof — screenshots + MP4 + a narrated report — and draft the PR/Slack surfaces. Deterministic bundler script + LLM narrative. |
| **meaningful-test-coverage** | Design + adversarially verify no-theater tests at the right level per layer; prove each guard would fail on the old code. Multi-agent workflow. |
| **meaningful-test-coverage** | Assess meaningful tests at the right level, including legitimate refactoring and obsolete-test removal. |
| **simplicity-review** | Review a change for over-engineering — speculative generality, gold-plating, dead code, needless indirection — and propose the simplest version that still meets the spec. The mirror of meaningful-test-coverage. |
| **spec-code-alignment** | Verify spec/design artifacts match the shipped code, catalog drift, remediate the lagging side — grounded in the code as source of truth. |
| **cross-repo-companion-pr** | Manage a change spanning a primary repo + a companion config/distro repo as paired, backward-compatible, cross-linked PRs. |
| **commit-pr-hygiene** | Team-specific commit/PR rules: format cold (defeat stale caches), timeless code comments, conventional trailer-clean messages, draft-before-posting. |
| **spec-code-alignment** | Verify spec/design artifacts match the shipped code, catalog drift, remediate the lagging side — distinguishing observed behavior from accepted requirements. |
| **cross-repo-companion-pr** | Review cross-repository contracts and explicit independent, ordered or atomic delivery. |
| **commit-pr-hygiene** | Formatting, comments, commit scope and authorized publication policy. |

Each skill is a directory under `skills/<name>/` with a `SKILL.md` (the agent-facing
instructions) and, where useful, a `scripts/` helper or a `workflow.template.js`.
instructions) and, where useful, a `scripts/` helper.

## Layout
```
review/ # local runner, contracts and adapters
tests/review/ # automated acceptance tests
docs/review-runner.md # supported usage and limits
skills/<name>/
SKILL.md # YAML frontmatter (name, description) + the procedure
scripts/*.mjs # optional deterministic helper(s)
workflow.template.js # optional multi-agent workflow template
```

## Install
Expand All @@ -50,13 +50,33 @@ node install.mjs --target /path/to/host-repo

## Requirements
- `evidence-bundle`: `ffmpeg` (webm→mp4) and `zip` on PATH.
- The workflow-based skills assume an agent runtime with a `Workflow`/subagent tool.
- Local review runner: Node.js 20+ and Git. Acceptance tests also need Python 3. Optional model review: Codex CLI. OpenELIS execution: Lima 2+, virtualization and sufficient build resources.

## License
MIT — see [LICENSE](LICENSE).

## Proposed review harness
## Local review harness (v0.4)

[OGC-1560 specification](docs/ogc-1560-review-harness/specification.md) proposes a
provider-independent PR review runner built on these skills. It includes source
research, reference-code checks and a staged pilot; the harness is not implemented.
**Implementation roadmap:** follow the [staged checklist](docs/ogc-1560-review-harness/roadmap.md). Stage 1 is in progress; the runner now distinguishes required evidence from execution settings.

Run a review of an existing PR:

```sh
node review/cli.mjs review --pr https://github.com/OWNER/REPO/pull/NUMBER --level L1
```

Choose L1 for deterministic checks or L2 for semantic review with explicit intent,
ownership, consumer and test assessments. L3–L5 require verification capabilities
that are still pending; they return partial before startup or model spend. Existing
declared OpenELIS checks remain usable with L1/L2.

The independent development profile defaults to one inexpensive Sol session.
Override the model explicitly; there is no core Sol/Luna allowlist. Reviewers inspect
pinned source on demand without a source-byte cap. No automatic model escalation occurs.

The [runner guide](docs/review-runner.md) includes installation, focused reviews,
limits, repository configuration and executable examples. Run `npm test` for
no-credit acceptance tests. The [implementation record](docs/ogc-1560-review-harness/implementation-status.md)
separates tested capabilities from remaining integrations and quality evaluation.
The [specification](docs/ogc-1560-review-harness/specification.md) defines the target contract; the checklist tracks implementation. Automatic publication, Claude integration and the model-quality pilot
are later work.
Loading
Loading