hyperledger-cactihyperledger-cacti/cacti/AGENTS.md

cacti

AGENTS.md412 starsChanged 4 months agoApache-2.0View on GitHub

Machine-readable guidance for AI coding agents. Hyperledger Cacti is a blockchain interoperability framework (Apache-2.0). TypeScript monorepo — Yarn 4 + Lerna, Node.js v20.20.0, packages in packages/, examples/, extensions/, weaver/. Safe read-only: git status, git diff, git log, git show, git blame, git fetch, git branch (list). Agents: .github/agents/ · Skills: .github/skills/ (ci-triage, codeql-scanning, doublecheck, package-removal, refactor-plan)

Deletes or force-pushes
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 31,843 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 repository8 other files it gives its agents.
- .github/copilot-instructions.mdCopilot instructions
- ci-triageSkill
- codeql-scanningSkill
- code-reviewSkill
- doublecheckSkill
- package-removalSkill
- refactor-planSkill
- <skill-name>Skill

The file

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

3 rules. About 0 are common, 3 are distinctive, and 0 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.
0
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Distinctive:
Every behaviour change has a test that fails without the change.
line 39
Distinctive:
No edits outside the scope stated in the task.
line 40
Distinctive:
No commits, pushes, or DCO tags added — report the diff to the human.
line 41

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

AGENTS.md — Hyperledger Cacti

Machine-readable guidance for AI coding agents.

Hyperledger Cacti is a blockchain interoperability framework (Apache-2.0). TypeScript monorepo — Yarn 4 + Lerna, Node.js v20.20.0, packages in packages/, examples/, extensions/, weaver/.

Restrictions

Action	Rule
`git commit` / `git push`	Forbidden — report changes, let the human commit
`git rebase` / `git merge` / `git reset --hard`	Forbidden, unless rebase to get latest code from upstream
`git tag` / `git clean -f`	Forbidden
`Signed-off-by` / `Assisted-by` tags	Forbidden — human submitter only
Create / merge PRs or issues	Requires explicit human approval
`--no-verify` / `HUSKY=0`	Forbidden
Delete files or branches	Requires explicit human confirmation
Edit files under `generated/`	Forbidden — run `yarn codegen` instead

Safe read-only: git status, git diff, git log, git show, git blame, git fetch, git branch (list).

Build and Test

nvm use 20.20.0          # required Node version
yarn configure           # install deps + build
yarn tsc                 # TypeScript compilation
yarn lint                # ESLint + Prettier + spellcheck
yarn codegen             # regenerate OpenAPI clients (never hand-edit generated/)

Before Proposing Changes

yarn tsc passes with no errors.
yarn lint passes and produces no unstaged file changes.
Every behaviour change has a test that fails without the change.
No edits outside the scope stated in the task.
No commits, pushes, or DCO tags added — report the diff to the human.

Do not modify without explicit approval

generated/ · weaver/ · whitepaper/ · GOVERNANCE.md · SECURITY.md · CODEOWNERS · .github/workflows/ · root tsconfig.json references · root package.json workspaces · lerna.json · tsconfig.base.json

Agent Pipelines

Goal	Pipeline
New feature	`feature-implementer → tdd-implementer → review → security-review → code-reviewer`
Bug fix	`debugger → ci-debugger → code-reviewer`
Code review	`review → security-review → code-reviewer`
CI triage	`ci-debugger → code-reviewer`
Security audit	`security-review → debugger → code-reviewer`

Agents: .github/agents/ · Skills: .github/skills/ (ci-triage, codeql-scanning, doublecheck, package-removal, refactor-plan)

Authoritative References

Document	Covers
CONVENTIONS.md	Naming, structure, TypeScript, testing, OpenAPI
CONTRIBUTING.md	Contribution workflow, DCO
AI_GUIDELINES.md	AI-assisted contribution policies
PULL.md	PR scope, size, commit format
BUILD.md	Dev environment setup
SECURITY.md	Security policy and reporting
.github/copilot-instructions.md	Copilot workspace rules + code review checklist
.github/instructions/	Path-scoped rules (TS, tests, plugins, connectors, SATP, OpenAPI, docs, workflows)

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.

Check your setup, free