agentleFS
oaslanankaoaslananka/kicad-mcp-pro/.github/AGENTS.md

kicad-mcp-pro

AGENTS.md169 starsChanged 18 days agoMITView on GitHub

These instructions apply to .github/** and supplement the repository root AGENTS.md. Workflow, ruleset, dependency-bot, CODEOWNERS, and release automation changes are policy changes. They can alter branch protection, supply-chain trust, publication identity, evidence, and security posture. Required status contexts are repository interfaces. Preserve the contexts documented in docs/engineering/ci-cd-policy.md, including the aggregate Required PR Gate, unless the live ruleset is intentionally migrated and verified in the same change. The local pytest coverage threshold remains blocking. Codecov project/patch statuses and test analytics are…

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

11 rules. About 1 is common, 7 are distinctive, and 3 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    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:

    Do not path-filter an entire required workflow in a way that leaves branch protection waiting for a context that never reports.

    line 25
  2. Distinctive:

    Do not rename a required job casually.

    line 27
  3. Very specific:

    Do not use continue-on-error, exclusions, or trigger narrowing to hide a repository-owned failure.

    line 28
  4. Distinctive:

    Keep workflow-scope permissions read-only by default.

    line 34
  5. Very specific:

    Add write scopes only at the narrow job that needs them and update .github/actions-policy.json in the same change.

    line 35
  6. Distinctive:

    Keep third-party Actions pinned to full commit SHAs.

    line 36
  7. Common:

    Do not expose secrets to untrusted fork code.

    line 37
  8. Distinctive:

    Do not interpolate PR-controlled expressions into shell commands without a safe boundary.

    line 38
  9. Distinctive:

    Do not weaken or silently bypass:

    line 43
  10. Distinctive:

    Do not publish from a local workstation, repoint immutable release tags, silently replace released assets, or replay a successful …

    line 68
  11. Very specific:

    Run the focused repository tests that lock ruleset/Mergify/required-check/release behavior and use task ci only when the change crosses …

    line 82

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 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

CI, Security, and Release Automation Instructions

These instructions apply to .github/** and supplement the repository root AGENTS.md.

Boundary

Workflow, ruleset, dependency-bot, CODEOWNERS, and release automation changes are policy changes. They can alter branch protection, supply-chain trust, publication identity, evidence, and security posture.

Read first:

  • docs/engineering/ci-cd-policy.md
  • docs/security/github-actions-policy.md
  • docs/security/release-integrity.md
  • docs/development/release-process.md
  • .github/actions-policy.json
  • .github/rulesets/main.json
  • .github/rulesets/release-tags.json

Required-check integrity

Required status contexts are repository interfaces.

Preserve the contexts documented in docs/engineering/ci-cd-policy.md, including the aggregate Required PR Gate, unless the live ruleset is intentionally migrated and verified in the same change.

  • Do not path-filter an entire required workflow in a way that leaves branch protection waiting for a context that never reports.
  • Preserve the step-level no-op pattern where required checks must report success for non-applicable changes.
  • Do not rename a required job casually; reconcile the ruleset, Mergify conditions, policy tests, and documentation together.
  • Do not use continue-on-error, exclusions, or trigger narrowing to hide a repository-owned failure.

The local pytest coverage threshold remains blocking. Codecov project/patch statuses and test analytics are reporting/telemetry under the current policy; do not accidentally turn external reporting availability into the sole coverage authority.

Permissions and untrusted input

  • Keep workflow-scope permissions read-only by default.
  • Add write scopes only at the narrow job that needs them and update .github/actions-policy.json in the same change.
  • Keep third-party Actions pinned to full commit SHAs.
  • Do not expose secrets to untrusted fork code.
  • Do not interpolate PR-controlled expressions into shell commands without a safe boundary.
  • Preserve separation between untrusted validation and privileged publication.

Security automation

Do not weaken or silently bypass:

  • Gitleaks;
  • CodeQL;
  • Dependency Review;
  • workflow policy/actionlint/zizmor enforcement;
  • dependency and filesystem/container vulnerability checks;
  • repository-settings drift auditing;
  • protected environment expectations.

External scanner or SaaS outages should be distinguished from repository-owned validation failures; do not suppress a real policy failure to make a run green.

Release and supply-chain automation

Production publication is privileged code. Preserve:

  • release/tag/source identity;
  • protected environments;
  • OIDC/trusted publishing;
  • artifact attestations and provenance;
  • SBOM and checksum evidence;
  • Sigstore/cosign verification where configured;
  • Python/npm/container/MCP Registry/protocol-schema channel semantics;
  • idempotency and post-publication verification.

Do not publish from a local workstation, repoint immutable release tags, silently replace released assets, or replay a successful publication mutation merely to repeat verification.

Human-only manufacturing controls and live-model release evidence are separate from software package publication; workflow refactors must not collapse those trust boundaries.

Workflow validation

For .github behavior changes run:

pnpm run workflows:policy
pnpm run workflows:lint
pnpm run workflows:security

Run the focused repository tests that lock ruleset/Mergify/required-check/release behavior and use task ci only when the change crosses enough boundaries to justify the full local CI equivalent.

A YAML parser passing is not sufficient. Validate permissions, trigger behavior, required contexts, artifact/evidence dependencies, and publication identity.

Definition of done

A GitHub automation change is complete only when workflow semantics, permissions, pins, required checks, repository policy tests, security controls, release evidence, and live repository settings remain consistent.

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.