agentleFS
opentensoropentensor/subtensor/AGENTS.md

subtensor

AGENTS.md401 starsChanged 3 months agoApache-2.0View on GitHub

Run the local gate before every push. It runs the checks CI requires, with the same commands CI uses, and exits nonzero on any failure: Install the pre-push hook once per checkout so a push cannot leave with a red gate: The hook gates the commits being pushed (each one in a detached worktree), not the working tree, and rejects a push of HEAD while uncommitted edits exist. It runs --fast, or the full gate when the pushed commits touch…

  • Commits and pushes

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

8 rules. About 0 are common, 3 are distinctive, and 5 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

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

    Run the local gate before every push.

    line 5
  2. Distinctive:

    Before any command that can rewrite files, inspect git status --short and preserve pre-existing changes as user-owned work.

    line 56
  3. Very specific:

    Do not hand-edit generated files: sdk/python/bittensor/_generated/, docs/tx/, docs/query/, docs/errors/, generated hyperparameter …

    line 63
  4. Very specific:

    Update sdk/python/bittensor/evm/abi/*.json only when drift is caused by the current canonical ABI change (uv run --no-sync pytest …

    line 70
  5. Very specific:

    Do not apply benchmark labels, run scripts/benchmark_all.sh, commit locally measured weights, or invent weight values unless explicitly …

    line 85
  6. Very specific:

    Treat unexpected lockfile changes as a stop-and-report condition.

    line 89
  7. Distinctive:

    Leave workflow execution to CI, preserve action pinning, and do not add an unapproved third-party action merely to make a workflow pass.

    line 96
  8. Very specific:

    Do not start clone/regression workflows, dependency audits, or benchmark generation as routine preflight.

    line 99

≈ “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

Repository Agent Guidance

CI preflight gate (mandatory before every push)

Run the local gate before every push. It runs the checks CI requires, with the same commands CI uses, and exits nonzero on any failure:

scripts/preflight.sh          # full gate; builds the release node when runtime metadata may have changed
scripts/preflight.sh --fast   # skips the node / wasm builds (SDK bindings drift, try-runtime)

Install the pre-push hook once per checkout so a push cannot leave with a red gate:

scripts/install-hooks.sh

The hook gates the commits being pushed (each one in a detached worktree), not the working tree, and rejects a push of HEAD while uncommitted edits exist. It runs --fast, or the full gate when the pushed commits touch runtime/, pallets/, or sdk/. git push --no-verify is forbidden for agents. Do not push to "see what CI says"; a new push cancels 40+ minutes of in-flight clone-upgrade and try-runtime work.

Pushes must go out as unarbos. The gate asks GitHub who owns the credential for the destination remote and fails unless that login is unarbos; it prints the git remote set-url fix (the PAT lives in the 1Password vault Arbos; never print it).

The gate covers: cargo fmt, CI-flag Clippy (default and --all-features), zepter, cargo test for changed crates plus the runtime fee/claim-root tests, SDK bindings drift from a node built from this tree, ruff, codegen.check, generate.py --check docs drift, pnpm run fmt, try-runtime against the mainnet snapshot when migrations changed, git diff --check, untracked generated files, and the push actor. ci_tips.md explains each failure.

CI repair loop (2026-09-30)

CI was already red during the Null consensus release work (PR #3206). Treat every failing check as something to diagnose: compare its tested SHA and logs with the base branch to distinguish existing failures, regressions, and infrastructure failures. An existing failure still needs resolution; do not waive it or call the release ready because it predates the change.

Watch checks continuously with fail-fast. As soon as any check fails, read its logs and start fixing the cause while other jobs continue. Once the fix is validated and the mandatory local preflight passes, commit and push immediately; do not wait for the entire remote suite to finish. Restart the watcher for the new SHA and repeat until the complete check set is green. The prohibition on no-op pushes and bypassing the pre-push hook still applies.

Fixing a red gate

Before any command that can rewrite files, inspect git status --short and preserve pre-existing changes as user-owned work. Use fix mode (cargo fmt --all, uv run --no-sync ruff format ., generate.py, pnpm run fmt:fix) only for failures attributable to files in the current task, then inspect the diff and rerun the gate. Do not run scripts/fix_rust.sh; it creates a commit.

Do not hand-edit generated files: sdk/python/bittensor/_generated/, docs/tx/, docs/query/, docs/errors/, generated hyperparameter index/meta files, or website/apps/bittensor-website/public/catalog/. Regenerate them with the gate or the commands it prints. Unexpected broad drift is a reason to stop and report, not to commit someone else's churn.

The Solidity ABI files in precompiles/src/solidity/*.abi are canonical. Update sdk/python/bittensor/evm/abi/*.json only when drift is caused by the current canonical ABI change (uv run --no-sync pytest tests/unit/test_evm.py::TestVendoredAbiSync -q from sdk/python).

Hand-written Markdown and MDX pages need string title and description frontmatter and may only reference existing MDX components.

Advisory-only checks

Runtime-affecting changes may require a spec_version newer than mainnet or the no-spec-version-bump PR label. Do not change spec_version or apply labels unless the user explicitly requests that action; report the requirement.

Adding or changing a dispatchable requires matching benchmarks and WeightInfo wiring. CI performs reference measurements and prepares a patch. Do not apply benchmark labels, run scripts/benchmark_all.sh, commit locally measured weights, or invent weight values unless explicitly requested on appropriate reference hardware.

Treat unexpected lockfile changes as a stop-and-report condition. Relevant lockfiles are Cargo.lock, sdk/python/uv.lock, ts-tests/pnpm-lock.yaml, website/yarn.lock, and .github/docs-preview-vercel/package-lock.json. Do not regenerate or revert a pre-existing lockfile change merely to make the working tree or CI clean.

For .github/** changes, run actionlint only when it is already available. Leave workflow execution to CI, preserve action pinning, and do not add an unapproved third-party action merely to make a workflow pass.

Do not start clone/regression workflows, dependency audits, or benchmark generation as routine preflight; scripts/preflight.sh already runs what CI requires.

Null release exception (2026-10-01)

For PR #3206, the owner explicitly chose a shared Null capacity of 2,500 UIDs (divided by emission mechanism count) and accepted Skeptic as the sole allowed non-green review check. Keep its result and findings visible; do not suppress the check or describe it as passed. All other CI checks and the mandatory local preflight/pre-push gate must pass. Further reward-accounting optimizations are deferred; payouts remain atomic. This exception does not supply measured weights or establish that deployment resource limits have passed.

Download now (ZIP)

  • 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 28,693 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 repository5 other files it gives its agents.

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.