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

easyeda-mcp-pro

AGENTS.md67 starsChanged 10 days agoMITView on GitHub

These instructions apply to .github/** and supplement the repository root AGENTS.md. Workflow and repository-control changes are policy changes. They can affect branch protection, security posture, dependency trust, release identity, provenance, registries, and public artifacts. Read these before material changes: Required status names are repository interfaces. - Keep the protected quality (24) context stable unless branch protection is intentionally migrated and verified in the same change. - Before renaming, deleting, or path-filtering an entire required workflow/job, verify how the live main…

The file

Show its rules and text

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

16 rules. About 2 are common, 10 are distinctive, and 4 are very specific to this project.

  • ≈2

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈10

    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
  1. Distinctive:

    Read these before material changes:

    line 10
  2. Very specific:

    Keep the protected quality (24) context stable unless branch protection is intentionally migrated and verified in the same change.

    line 23
  3. Distinctive:

    Before renaming, deleting, or path-filtering an entire required workflow/job, verify how the live main ruleset resolves the check.

    line 25
  4. Distinctive:

    Avoid configurations that leave branch protection waiting forever for a required context that no longer runs.

    line 27
  5. Very specific:

    Do not use continue-on-error, exclusions, or trigger narrowing to conceal a repository-owned test, audit, packaging, security, or release …

    line 29
  6. Very specific:

    Use least-privilege permissions at workflow and job scope.

    line 38
  7. Common:

    Keep checkout credentials disabled unless a reviewed mutation requires them.

    line 39
  8. Common:

    Do not expose secrets to untrusted fork code or interpolate untrusted event data into shell commands without a safe boundary.

    line 40
  9. Distinctive:

    Keep GitHub Actions SHA-pinned.

    line 43
  10. Distinctive:

    Do not replay a previously successful publication mutation merely to repeat verification.

    line 76
  11. Distinctive:

    Do not repoint immutable release tags, silently replace released assets, or publish from an unverified source revision.

    line 79
  12. Distinctive:

    When workflow behavior changes:

    line 84
  13. Distinctive:

    update the corresponding policy/runbook documentation and repository-policy tests when required.

    line 86
  14. Distinctive:

    keep scheduled/advisory automation distinct from genuinely merge-critical validation.

    line 88
  15. Distinctive:

    prefer reusable workflow/composite-action boundaries only when they clarify ownership rather than hiding critical execution flow.

    line 89
  16. Very specific:

    Before handoff or PR creation, run pnpm verify.

    line 102

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 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 and Release Automation Instructions

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

Boundary

Workflow and repository-control changes are policy changes. They can affect branch protection, security posture, dependency trust, release identity, provenance, registries, and public artifacts.

Read these before material changes:

  • docs/REPOSITORY_GOVERNANCE.md
  • docs/RELEASE_POLICY.md
  • docs/RELEASE_PROCESS.md
  • docs/RELEASE_VERIFICATION.md
  • docs/release-ci-runbook.md
  • docs/security-architecture.md

Required-check integrity

Required status names are repository interfaces.

  • Keep the protected quality (24) context stable unless branch protection is intentionally migrated and verified in the same change.
  • Before renaming, deleting, or path-filtering an entire required workflow/job, verify how the live main ruleset resolves the check.
  • Avoid configurations that leave branch protection waiting forever for a required context that no longer runs.
  • Do not use continue-on-error, exclusions, or trigger narrowing to conceal a repository-owned test, audit, packaging, security, or release failure.

External telemetry is different from repository-owned validation. The current policy keeps local Vitest coverage thresholds, changed-line LCOV enforcement, and report validation merge-critical while Codecov upload telemetry is non-blocking. Do not reverse that policy accidentally through workflow refactoring.

Permissions and untrusted input

  • Use least-privilege permissions at workflow and job scope.
  • Keep checkout credentials disabled unless a reviewed mutation requires them.
  • Do not expose secrets to untrusted fork code or interpolate untrusted event data into shell commands without a safe boundary.
  • Preserve separation between untrusted validation and privileged publication.
  • Keep GitHub Actions SHA-pinned; do not replace immutable pins with floating tags for convenience.

Security and dependency automation

Do not weaken:

  • CodeQL/Semgrep/static analysis;
  • Dependency Review and repository dependency-audit policy;
  • secret scanning/hygiene;
  • workflow security checks;
  • container/image security where configured;
  • runtime/dependency pin parity.

An external scanner outage is not evidence that repository security policy should be bypassed. Record the external failure separately from repository-owned gate results.

Release and publication

Release workflows are privileged supply-chain code.

Preserve:

  • exact source/tag/channel identity;
  • stable vs prerelease channel separation;
  • immutable version/tag expectations;
  • npm provenance/trusted publication requirements;
  • SBOM generation and retention;
  • GitHub attestation/provenance evidence;
  • extension artifact identity;
  • GHCR exact/channel tag semantics;
  • stable MCP Registry promotion rules;
  • post-publication verification and recovery semantics.

Do not replay a previously successful publication mutation merely to repeat verification. Follow the documented recovery path.

Do not repoint immutable release tags, silently replace released assets, or publish from an unverified source revision.

Workflow maintenance

When workflow behavior changes:

  • update the corresponding policy/runbook documentation and repository-policy tests when required;
  • preserve stable artifact names/evidence contracts consumed by downstream jobs or release tooling;
  • keep scheduled/advisory automation distinct from genuinely merge-critical validation;
  • prefer reusable workflow/composite-action boundaries only when they clarify ownership rather than hiding critical execution flow.

Validation

For workflow changes, run the repository's local hook/security tooling applicable to GitHub Actions, then at minimum:

pnpm format:check
pnpm verify:fast

Before handoff or PR creation, run pnpm verify.

A YAML parser passing is not enough. Validate GitHub Actions semantics, permissions, required-check behavior, and any release/security contract affected by the change.

Definition of done

A CI/release change is complete only when workflow syntax, security linting, required-check behavior, permissions, evidence/artifact contracts, release identity, and documentation agree.

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.