Skip to content

docs(readme): five-minute evaluation + use/do-not-use guidance #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brunovicco merged 1 commit into from
Jul 20, 2026
Merged

docs(readme): five-minute evaluation + use/do-not-use guidance #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ The format follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and

## [Unreleased]

### Added

- README "Five-minute evaluation" section, matching the sibling
`codex-python-engineering-harness`: a disposable, credential-free local evaluation with a
single quality-gate command, plus explicit use / do-not-use guidance.

## 1.0.0 - 2026-07-19

First tagged release. Consolidates the loop foundation below and closes the structural-parity gap
Expand Down
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,23 @@ For a short hands-on walkthrough, generated tree, profile comparison, and explic
criteria, see the [evaluation guide](docs/EVALUATION.md). A complete generated service is available
in [`brunovicco/claude-python-engineering-harness-example`](https://github.com/brunovicco/claude-python-engineering-harness-example).

## Five-minute evaluation

Requirements: Python 3.12 or newer and `uv`.

```bash
target="$(mktemp -d)/harness-evaluation"
python3 bootstrap.py --name evaluation --package evaluation --target "$target" --profile service
cd "$target"
uv sync --all-groups
uv run python scripts/quality_gate.py
```

Then inspect `CLAUDE.md`, `.claude/settings.json`, `.claude/rules/`, `.claude/hooks/`, and
`docs/ARCHITECTURE.md`. This evaluation creates only a disposable local project and requires no
credentials. Use the harness when you want an opinionated, repository-owned engineering baseline;
do not use it when an existing project cannot adopt its uv workflow or architectural constraints.

## Profiles

- `service` keeps Pydantic, structlog, Clean Architecture, Docker, and optional Langfuse tracing.
Expand Down