-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add AGENTS.md guidance #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
4f7d641
docs: add AGENTS.md guidance; fix claude-usage-report plugin source
goneflyin 61c27aa
docs: trim AGENTS.md to mistake-preventing guidance
goneflyin f44aac5
docs: drop marketplace.json fix (moved to #7)
goneflyin 1562b22
docs: re-add explanation about symlinked skills and extend
goneflyin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # AGENTS.md | ||
|
|
||
| This file provides guidance to coding agents (Claude Code, Codex, and others) when working with code in this repository. | ||
|
|
||
| ## Workflow | ||
|
|
||
| `main` is protected: you **cannot push directly to `main`**. All changes land via a pull request to main (push only when the user directs it). | ||
|
|
||
| ## Organization | ||
|
|
||
| - `.claude/skills` is a **symlink** to `.agents/skills`. The repo-local `write-a-skill` skill lives at | ||
| `.agents/skills/write-a-skill/` and is the authoring guide/checklist — use it when adding or changing a skill. | ||
| - Some skills in `.agents/skills` may be **symlinks** to skills in `skills` to guarantee the version of a skill | ||
| used is the latest one in the repository. | ||
|
|
||
| ## Skill install paths are not equivalent | ||
|
|
||
| Skills in this repo are consumed two ways, and they install different things: | ||
|
|
||
| - **skills.sh** (`npx skills add 7Factor/skills --skill <name>`) — copies skill files only. It does | ||
| **not** install hooks, MCP servers, or agents. Cross-agent (Claude Code, Codex, etc.). | ||
| - **Claude Code plugin** (`/plugin marketplace add 7Factor/skills` → `/plugin install <name>@7factor`) — | ||
| installs the skill **and** its hooks. Required whenever a skill depends on a hook. | ||
|
|
||
| If a skill needs a hook/MCP/agent, remember skills.sh installs won't get it — document the plugin path. | ||
|
|
||
| ## marketplace.json: source format matters | ||
|
|
||
| A plugin entry that ships skills must **not** combine a bare relative-string `source` with a `skills` array — | ||
| that specific combination trips Claude Code's plugin resolver into a misleading "update Claude Code" error. | ||
| Use the `git-subdir` object form for skill-bearing plugins: | ||
|
|
||
| ```json | ||
| "source": { | ||
| "source": "git-subdir", | ||
| "url": "https://github.com/7Factor/skills.git", | ||
| "path": "skills/<name>", | ||
| "ref": "main" | ||
| } | ||
| ``` | ||
|
|
||
| After editing `marketplace.json`, changes only take effect once pushed and the marketplace is re-pulled | ||
| (`/plugin marketplace update 7factor`); the copy under `~/.claude/plugins/marketplaces/7factor` is a cache. | ||
|
dumptruckman marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| # CLAUDE.md | ||
|
|
||
| This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository. | ||
|
|
||
| See [AGENTS.md](AGENTS.md) for all repository guidance. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.