Skip to content

Review agent developer experience: CLAUDE.md, contribution docs, and agent UX #9

@crtahlin

Description

@crtahlin

Goal

Ensure this repo is well-prepared for developers using AI coding agents (Claude Code, Cursor, Copilot, etc.) and for agents contributing directly.

Checklist

  • CLAUDE.md / AGENTS.md exists — provides context for AI agents working on this codebase (architecture, conventions, key files, test commands)
  • Contributing guide — clear instructions for how to contribute (setup, PR process, code style) that agents can follow
  • README setup instructions — can an agent clone, install, and run tests without ambiguity?
  • Test commands documented — single command to run full test suite, clearly stated
  • Code style / linting — automated formatting so agent PRs don't fail on style
  • Agent UX review — are error messages, CLI output, and API responses clear enough for an agent to understand and act on? Are suggestions surfaced?

Context

Part of the Provenance Toolkit agent-readiness initiative. As AI coding agents become standard developer tools, our repos should be easy for them to work with — both for contributing code and for using the tools programmatically.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions