netresearch/agent-rules-skill / skills/agent-rules
agent-rules
FlaggedUse when creating or updating AGENTS.md files, .github/copilot-instructions.md, or other AI agent rule files, onboarding AI agents to a project, standardizing agent documentation, or when anyone mentions AGENTS.md, agent rules, project onboarding, or codebase documentation for AI agents.
scripts/tests/test-claude-import-file.sh
View on GitHub#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# SPDX-FileCopyrightText: Netresearch DTT GmbH
# Regression test for CLAUDE.md import-file handling (issue #82).
#
# The TYPO3 docs renderer lists Documentation/ via Flysystem, which aborts on
# any symbolic link, so a CLAUDE.md -> AGENTS.md symlink there breaks docs CI.
# generate-agents.sh must emit a regular "@AGENTS.md" import file for
# Documentation/ scopes, and validate-structure.sh must accept that file as
# fully valid, while still warning on other regular CLAUDE.md files.
set -uo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
SCRIPTS_DIR="$(dirname "$SCRIPT_DIR")"
GENERATE="$SCRIPTS_DIR/generate-agents.sh"
VALIDATE="$SCRIPTS_DIR/validate-structure.sh"
WORK="$(mktemp -d)"
trap 'rm -rf "$WORK"' EXIT
fail() { echo "❌ FAIL: $1"; exit 1; }
pass() { echo "✅ PASS: $1"; }
# PHP fixture with a Documentation/ scope (>=3 RST files) and enough source
# files that generate-agents.sh emits a root plus scoped files.
FX="$WORK/php-docs"
mkdir -p "$FX/src" "$FX/Documentation"
cat > "$FX/composer.json" <<'JSON'
{ "name": "acme/fixture", "require": { "php": "^8.2" }, "scripts": { "test": "phpunit" } }
JSON
# detect-scopes.sh needs MIN_FILES=5 source files for an src scope.
for i in 1 2 3 4 5; do printf '<?php\nclass C%s {}\n' "$i" > "$FX/src/C$i.php"; done
for i in 1 2 3; do printf 'Chapter %s\n=========\n' "$i" > "$FX/Documentation/Ch$i.rst"; done
git -C "$FX" init -q
git -C "$FX" -c user.email=t@t.t -c user.name=t add -A
git -C "$FX" -c user.email=t@t.t -c user.name=t commit -qm init
# --- Test 1: generator emits an import FILE, not a symlink, in Documentation/
bash "$GENERATE" "$FX" --style=thin >/dev/null 2>&1 || fail "generate-agents.sh errored"
[ -f "$FX/Documentation/AGENTS.md" ] \
|| fail "fixture did not produce a scoped Documentation/AGENTS.md (scope not detected; fix the fixture)"
[ -e "$FX/Documentation/CLAUDE.md" ] || fail "no Documentation/CLAUDE.md generated"
if [ -L "$FX/Documentation/CLAUDE.md" ]; then
fail "Documentation/CLAUDE.md is a symlink -- breaks TYPO3 docs rendering (#82)"
fi
grep -qE '^@AGENTS\.md[[:space:]]*$' "$FX/Documentation/CLAUDE.md" \
|| fail "Documentation/CLAUDE.md lacks the @AGENTS.md import line"
pass "generator emits @AGENTS.md import file in Documentation/"
# Non-hostile scope dirs must still get symlinks.
[ -e "$FX/src/CLAUDE.md" ] || fail "no src/CLAUDE.md generated (src scope not detected; fixture needs >=5 source files)"
[ -L "$FX/src/CLAUDE.md" ] || fail "src/CLAUDE.md should still be a symlink"
pass "non-hostile scope dirs still get symlinks"
# --- Test 2: validator accepts the import file without a warning -------------
out=$(bash "$VALIDATE" "$FX" 2>&1)
if echo "$out" | grep -q "CLAUDE.md is a regular file"; then
fail "validate-structure.sh still warns about the @AGENTS.md import file"
fi
pass "validator accepts the @AGENTS.md import file"
# --- Test 3: a regular CLAUDE.md without the import still warns --------------
printf 'unrelated content\n' > "$FX/Documentation/CLAUDE.md"
out=$(bash "$VALIDATE" "$FX" 2>&1)
if ! echo "$out" | grep -q "CLAUDE.md is a regular file"; then
fail "validate-structure.sh no longer warns about a non-import regular CLAUDE.md"
fi
pass "non-import regular CLAUDE.md still warns"
echo "All CLAUDE.md import-file regression tests passed."
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 470k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 197k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |