agentleFS
AWSKnown publisherawslabs/content-accessibility-utility-on-aws/CLAUDE.md

content-accessibility-utility-on-aws

CLAUDE.md10 starsChanged 4 months agoApache-2.0View on GitHub

Start here, then read the linked docs — this file is an index, not a manual. - CONTRIBUTING.md — build/test commands, the PR workflow, and the documentation requirement (docs must be updated in the same PR; see its Documentation section for the change-→-page map, the GitHub Pages site, and the diagram workflow). - **TESTING_PLAN.md** — the tiered test strategy. - README.md — what the project is and the three ways to use it. - User docs — docs/, published as…

  • In this repositoryOne other file it gives its agents.

The file

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

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Start here, then read the linked docs — this file is an index, not a manual.

    line 8
  2. Very specific:

    Before committing, the default pytest run (see CONTRIBUTING.md) must pass.

    line 25

≈ “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
<!-- Copyright 2025 Amazon.com, Inc. or its affiliates. SPDX-License-Identifier: Apache-2.0 -->

Guidance for AI coding agents

Start here, then read the linked docs — this file is an index, not a manual.

  • CONTRIBUTING.md — build/test commands, the PR workflow, and the documentation requirement (docs must be updated in the same PR; see its Documentation section for the change-→-page map, the GitHub Pages site, and the diagram workflow).
  • TESTING_PLAN.md — the tiered test strategy.
  • README.md — what the project is and the three ways to use it.
  • User docs — docs/, published as a GitHub Pages site; the guides are the authoritative reference for the CLI, API, and pipeline.

Rules for agents

  1. Keep docs in lockstep with code. Any user-visible change must update the matching page(s) in the same change — follow the map in CONTRIBUTING.md § Documentation. This is a requirement, not a follow-up.
  2. Before committing, the default pytest run (see CONTRIBUTING.md) must pass.
  3. Match the conventions already in the tree: the Apache-2.0 header on new files, inclusive language, and the style of surrounding code.

Other agents (Codex, etc.) are routed here via AGENTS.md.

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.