Skip to content

AGENTS.md: add an agent guide that points to the plugin marketplace

Add AGENTS.md, an agent guide for this repository. Link CLAUDE.md to it.

Two commits.

1. AGENTS.md

AGENTS.md follows the agents.md spec, so every AI coding assistant that reads the file gets the same instructions. The file is short on purpose. It holds only what an agent cannot read from the code:

  • what this repository is: the software release list, with software/ as the core, and slapos.cookbook as a tool that the software releases use,
  • where the tests are: the README.md of software/slapos-testing and of software/slapos-sr-testing,
  • the code style,
  • the commit message format,
  • the rules for written English in published text,
  • the push safety rules.

The development skills and the coding rules are not in this repository. They live in the slapos-agent-skill-marketplace marketplace, as four plugins: slapos-software-release, slapos-build-deploy, slapos-diagnostics and slapos-coding-rules. AGENTS.md names the plugins, says what each one does, and gives the install command. A procedure stays in one place. AGENTS.md does not copy it.

Published text follows ASD-STE100 Simplified Technical English. ASD-STE100 is the controlled English of the aerospace and defence industry. Many reviewers do not have English as a first language. A named standard also gives an AI agent a rule set that it can apply.

2. The CLAUDE.md symlink

Claude Code reads CLAUDE.md. Claude Code does not read AGENTS.md. The maintainers closed the request for AGENTS.md support on 2026-08-17, in issue 6235 of the claude-code tracker, and gave two methods: an import, or a symlink.

The second commit adds the symlink CLAUDE.md to AGENTS.md. The symlink is 9 bytes and holds no content. One guide serves every agent.

A Windows user needs Administrator rights or Developer Mode for a symlink. On Windows, replace the symlink in your checkout with a file that holds the single line @AGENTS.md.

.gitignore ignores the .claude directory. That directory holds the configuration of one tool and of one machine.

Edited by Cédric Le Ninivin

Merge request reports