Skip to content

docs(readme): make every claim true and current - #3

Merged
nonagenticai-claude[bot] merged 1 commit into
mainfrom
lane/readme-quality
Nov 14, 2026
Merged

nonagenticai-claude[bot] merged 1 commit into
mainfrom
lane/readme-quality

Conversation

@nonagenticai-claude

Copy link
Copy Markdown
Contributor

Why

An audit of README.md against origin/main found a wrong tool count, a false environment
variable claim, missing request/response contract detail and missing template sections. This PR
changes only README.md — no code, workflow or config file is touched.

Corrections, each with its proof

  1. "9 quality/linting tools" was wrong — it is 8. parse_tool_output dispatches exactly
    ruff, ty, bandit, eslint, ruff-format, prettier, vulture and radon.
    Proof: src/result_processor.py:45-58. Both mentions now say 8 and name them.

  2. The Configuration table claimed PORT is the HTTP listen port. The application reads no
    environment variables at all — src/ contains no os.getenv/os.environ call. The port is
    fixed by the uvicorn command line: --port 8087 in the Dockerfile CMD, and
    uvicorn.run(port=8087) at src/test_service.py:334-341. PORT and TEST_MODE are set by
    the image/compose file but are not read; the table now says so.

  3. Documented the undocumented X-Tenant-Id requirement. / and /health are exempt;
    /execute, /docs, /redoc and /openapi.json return 401 without the header
    (require_tenant_header, _TENANT_EXEMPT_PATHS, src/test_service.py:36-48). This also
    made the old example curl fail; it now sends the header. The Security section states it is
    an access marker, not authentication or tenancy.

  4. POST /execute documentation made current. The request model has a test_code field
    that switches execution to pytest, and the response carries tests_run, tests_passed,
    tests_failed and no_tests_run, with error categories syntax_error, timeout,
    no_tests_collected, tests_failed, execution_failed and internal_error.
    Proof: src/test_service.py:64-110 (models) and :148-330 (handler). Both execution
    modes and the temp-file names are documented.

  5. Removed the false uv build claim from CI/CD. Neither the repo workflow nor the shared
    archetype runs it. Proof: .github/workflows/ci.yml and
    nonagenticai/ci-workflows/.github/workflows/python-service.yml. The section now lists the
    actual steps: secret/private-ref scans, uv lock --check, ruff check + format, ty, the
    pytest unit suite, bandit, pip-audit, image build + /health smoke, and the sha-<commit> /
    latest publish with provenance from main.

  6. Kept the claims that are true and now cite them: Python 3.14 (python:3.14-slim,
    requires-python = ">=3.14"), uv 0.13.7, ruff 0.17.3 / ty 0.0.92 / bandit 1.9.4 as
    isolated uv tool installs (Dockerfile), the read-only Docker socket mount
    (docker-compose.yml), and the unused redis dependency (no redis import in src/).

  7. Added the missing standard sections: CI and licence badges, Quick start, Security,
    Contributing, and ## Licensing / ## License. The Release badge is deliberately omitted:
    gh release list -R nonagenticai/python-test-executor returns no releases, so the badge
    would only point at an empty page.

  8. Licensing: the code is Apache-2.0 and needs no licence key. This service performs no
    licence enforcement: it reads no licence environment variable and never calls a licence
    server (git grep -i licen origin/main finds only the LICENSE file and transitive
    license-expression lock entries). The estate's optional gate is external — Envoy
    ext_authz → license-authz, selected by the LICENSE_GATED_APP_KEY host table; the
    default is no gate for an unlisted host and this service is not listed.

Verification

  • git show --stat on this branch: README.md only (1 file changed).
  • git diff --check clean.
  • Branch local push gate: secret scan, ruff lint/format, ty and the pytest suite all passed.

🤖 Generated with Claude Code

Co-Authored-By: Claude Code <noreply@anthropic.com>
@nonagenticai-claude
nonagenticai-claude Bot merged commit 26be561 into main Nov 14, 2026
7 checks passed
@nonagenticai-claude
nonagenticai-claude Bot deleted the lane/readme-quality branch November 14, 2026 22:58
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