agentleFS
Sign inStart free
arklexaiarklexai/arksim/CLAUDE.md

arksim

CLAUDE.md234 starsChanged 8 months agoApache-2.0View on GitHub

Agent simulation and evaluation framework. Python 3.10+, Apache-2.0. Key directories: arksim/ (source), tests/unit/ (CI tests), tests/integration/, docs/ (Mintlify), examples/, integration-tests/. Makefile: make install-dev, make lint, make format, make test, make clean. See @.claude/rules/python-style.md for all Python rules (auto-enforced by hooks). PRs are squash-merged. The PR title becomes the commit on main. Title regex (CI-enforced): PR title format, PR description (20 char min), pre-commit hooks, ruff check + format, bandit security scan, CodeQL, pytest across 3.10-3.13, Codecov upload. Mintlify docs live…

  • Reads credentials
  • Installs packages

The file

We split this CLAUDE.md into the rules it gives an agent

9 rules. About 0 are common, 5 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Very specific:

    Update CHANGELOG.md under [Unreleased] (Added, Changed, Fixed, Removed).

    line 35
  2. Very specific:

    Do not edit versioned snapshot folders (docs/v0.x.x/).

    line 61
  3. Distinctive:

    No em dashes or en dashes in prose.

    line 65
  4. Distinctive:

    No AI attribution in commits, PRs, docs, or any artifacts.

    line 66
  5. Distinctive:

    No ticket IDs in branch names (this is an open-source repo).

    line 75
  6. Very specific:

    Do not commit .env files, secrets, or credentials.

    line 79
  7. Very specific:

    Do not edit versioned doc snapshot folders (docs/v0.x.x/).

    line 80
  8. Distinctive:

    Do not bundle unrelated changes in a single PR.

    line 81
  9. Distinctive:

    Do not add files over 500KB without discussion.

    line 82

≈ “Common” is an estimate: at least 1 in 5 of the 26,980 CLAUDE.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
CLAUDE.md

arksim

Agent simulation and evaluation framework. Python 3.10+, Apache-2.0.

Project structure

Key directories: arksim/ (source), tests/unit/ (CI tests), tests/integration/, docs/ (Mintlify), examples/, integration-tests/.

Dev setup

pip install -e ".[dev]"
pre-commit install

Makefile: make install-dev, make lint, make format, make test, make clean.

Code style

See @.claude/rules/python-style.md for all Python rules (auto-enforced by hooks).

PR conventions

PRs are squash-merged. The PR title becomes the commit on main.

Title regex (CI-enforced):

^(feat|fix|docs|chore|ci|build|refactor|test|perf|style|revert)(\([a-z][a-z0-9_-]*\))?!?: .+$
  • Max 72 characters. Scope recommended but optional.
  • Common mistakes: using a component name (e.g. evaluator:) as the type, putting ticket IDs in the title.
  • Description body must have 20+ characters of real content.
  • Update CHANGELOG.md under [Unreleased] (Added, Changed, Fixed, Removed).

Testing

pytest tests/unit/          # What CI runs
pytest tests/ --cov=arksim  # Full suite with coverage
  • pytest with pytest-asyncio (auto mode). Markers: unit, integration, slow.
  • Coverage minimum: 60%. CI matrix: Python 3.10-3.13.

CI checks

PR title format, PR description (20 char min), pre-commit hooks, ruff check + format, bandit security scan, CodeQL, pytest across 3.10-3.13, Codecov upload.

Hooks (.claude/settings.json)

  • SessionStart: prints current branch and any open PR for context.
  • PreToolUse (Edit|Write): blocks edits to .env files and secrets//credentials//keys/ dirs.
  • PostToolUse (Edit|Write): auto-runs ruff format + ruff check --fix on saved .py files.

Documentation

Mintlify docs live in docs/. Use relative links within version folders. Do not edit versioned snapshot folders (docs/v0.x.x/).

Writing style

  • No em dashes or en dashes in prose. Use hyphens only where grammatically required.
  • No AI attribution in commits, PRs, docs, or any artifacts.

Branch naming

<type>/<short-description>

Examples: feat/retry-logic, fix/empty-list-handling, docs/update-quickstart. No ticket IDs in branch names (this is an open-source repo).

What NOT to do

  • Do not commit .env files, secrets, or credentials.
  • Do not edit versioned doc snapshot folders (docs/v0.x.x/).
  • Do not bundle unrelated changes in a single PR.
  • Do not add files over 500KB without discussion.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free