agentleFS
someboxsomebox/pcb-kit/AGENTS.md

pcb-kit

AGENTS.md4 starsChanged 28 days agoMITView on GitHub

This repo is the shared engine for several KiCad hardware projects. Read README.md for the commands and docs/CONVENTIONS.md for how the projects are laid out. The skill in skills/pcb-kit/SKILL.md is what an agent sees inside a project. - Everything under pcbkit/ must import cleanly under Python 3.9 (KiCad's bundled interpreter) with no third-party packages. pcbnew is imported inside functions, after ensure_pcbnew(). - pcbkit_router/ is the one exception: it runs under its own Python (numba, numpy, scipy, pillow; pcbkit setup-router), never…

  • Commits and pushes
  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 32,671 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository9 other files it gives its agents.

The file

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

4 rules. About 0 are common, 1 is distinctive, and 3 are 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.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    No project names, board names or net names in the package.

    line 11
  2. Very specific:

    When a script is harvested from a project, record it in docs/HARVEST.md with its source and what changed.

    line 15
  3. Very specific:

    Test a change on more than one project's boards before committing: the sign, siebenuhr, spotlight and dodeca repos are the corpus.

    line 16
  4. Very specific:

    Commit messages: imperative, prefixed with the area (checks:, release:, schematic:, skills:, docs:).

    line 20

≈ “Common” is an estimate: at least 1 in 5 of the 41,581 AGENTS.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
AGENTS.md

Working in pcb-kit

This repo is the shared engine for several KiCad hardware projects. Read README.md for the commands and docs/CONVENTIONS.md for how the projects are laid out. The skill in skills/pcb-kit/SKILL.md is what an agent sees inside a project.

  • Everything under pcbkit/ must import cleanly under Python 3.9 (KiCad's bundled interpreter) with no third-party packages. pcbnew is imported inside functions, after ensure_pcbnew().
  • pcbkit_router/ is the one exception: it runs under its own Python (numba, numpy, scipy, pillow; pcbkit setup-router), never imports pcbnew or pcbkit, and nothing in pcbkit/ imports it. pcbkit/reroute/ runs it as a process.
  • No project names, board names or net names in the package. If a value belongs to one board, it is a flag, a config file in that project, or a parameter.
  • A part goes into library/PARTS.md once a built board has proven it; cite the project and keep the notes to what the project's documents or the datasheet say. Parts only in a design go in its "not built yet" section.
  • When a script is harvested from a project, record it in docs/HARVEST.md with its source and what changed.
  • Test a change on more than one project's boards before committing: the sign, siebenuhr, spotlight and dodeca repos are the corpus. A change to the router is judged with pcbkit reroute corpus, against bench/baseline.json (see docs/ROUTER.md). tests/ holds fixture boards drawn in pcbnew; each python3 tests/test_*.py (route_check, courtyards, import_easyeda, release) runs its own under KiCad's Python.
  • Commit messages: imperative, prefixed with the area (checks:, release:, schematic:, skills:, docs:).

Releases

Versions follow semver; before 1.0 a minor version may change a command, a flag or a skill's instructions. A change that a project or an agent would notice gets a line under ## [Unreleased] in CHANGELOG.md, in the same PR. To cut a release:

python3 scripts/release.py bump 0.4.0   # on a branch: the four version strings, and [Unreleased] -> [0.4.0] - today
                                        # commit as "release: 0.4.0", open a PR, merge it
git switch main && git pull
python3 scripts/release.py tag          # checks main is clean and pushed, then makes the annotated tag v0.4.0
git push origin v0.4.0                  # .github/workflows/release.yml publishes the release from CHANGELOG.md

python3 scripts/release.py check says whether the four version strings agree; the workflow runs it on every PR.

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.