From b665c5c59621d1b7453d243afc108059b27d7d7a Mon Sep 17 00:00:00 2001 From: Joan Leon Date: Thu, 9 Jul 2026 21:22:08 +0200 Subject: [PATCH] docs: clarify AGENTS.md and CLAUDE.md are repo-scoped Add a Scope banner to AGENTS.md and CLAUDE.md stating they configure agents working on the addyosmani/agent-skills repository itself, not users' own projects, referencing the repo by its canonical GitHub URL so the scope is unambiguous when the file is read out of context. Add a matching "Repo-scoped files" note to CONTRIBUTING.md so setup-guide authors don't instruct users to copy these files. --- AGENTS.md | 2 ++ CLAUDE.md | 2 ++ CONTRIBUTING.md | 4 ++++ 3 files changed, 8 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index 2fdfd9b4..e97670ed 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,6 +2,8 @@ This file provides guidance to AI coding agents (Claude Code, Cursor, Copilot, Antigravity, etc.) when working with code in this repository. +> **Scope:** This file configures agents working on the [`addyosmani/agent-skills`](https://github.com/addyosmani/agent-skills) repository itself. It is not meant to be copied into other projects or into a global agent configuration; the reusable assets are the skills in `skills/`, not this file. + ## Repository Overview A collection of skills for Claude.ai and Claude Code for senior software engineers. Skills are packaged instructions and scripts that extend Claude and your coding agents capabilities. diff --git a/CLAUDE.md b/CLAUDE.md index 43296fa0..5382b3db 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -2,6 +2,8 @@ This is the agent-skills project — a collection of production-grade engineering skills for AI coding agents. +> **Scope:** This file configures agents working on the [`addyosmani/agent-skills`](https://github.com/addyosmani/agent-skills) repository itself, not other projects. Don't copy it into another project or a global agent configuration; the reusable assets are the skills in `skills/`. + ## Project Structure ``` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4461ab42..5c5ad218 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,6 +64,10 @@ The frontmatter fields above are required. The section anatomy is a recommended - Preserve the existing structure and tone - Test that YAML frontmatter remains valid after edits +## Repo-scoped files + +`AGENTS.md` and `CLAUDE.md` at the repo root configure agents working on the [`addyosmani/agent-skills`](https://github.com/addyosmani/agent-skills) repository itself. When writing setup guides or docs, do not instruct users to copy these files into their own projects or into a global agent configuration; the reusable assets are the skills in `skills/`. + ## Testing Hooks The session-start hook (`hooks/session-start.sh`) injects the `using-agent-skills` meta-skill into every new Claude Code session. A regression test at `hooks/session-start-test.sh` validates the hook's JSON payload — both when `jq` is available and when it isn't.