Skip to content

Commit 9d97502

Browse files
authored
Merge pull request #14 from smartcontractkit/chore/add-claude-md
Add CLAUDE.md to project root
2 parents e85b436 + 9aca822 commit 9d97502

2 files changed

Lines changed: 36 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@CLAUDE.md

CLAUDE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Chainlink Agent Skills - Development Guide
2+
3+
## Project Structure
4+
5+
This is a monorepo of Chainlink agent skills. Each skill lives in its own top-level directory (e.g., `chainlink-ccip-skill/`, `chainlink-cre-skill/`, `chainlink-data-feeds-skill/`).
6+
7+
Each skill directory contains:
8+
- `SKILL.md` - The skill definition with YAML frontmatter (name, description, version) and markdown instructions
9+
- `references/` - Supporting reference docs the skill reads at runtime
10+
- `agents/` (optional) - Platform-specific agent configs (e.g., `openai.yaml`)
11+
- `assets/` (optional) - Supplementary assets like doc indexes
12+
13+
Evals live in `evals/<skill-name>/` with test cases, rubrics, and promptfoo configs.
14+
15+
## Versioning
16+
17+
Each skill tracks its own version in its `SKILL.md` frontmatter under `metadata.version` using semver (e.g., `"0.0.3"`).
18+
19+
**When you modify any file within a skill directory, bump that skill's patch version** (the `0.0.x` component) in its `SKILL.md` frontmatter. Only bump the skill that was actually changed. Do not bump versions for other skills that were not touched.
20+
21+
## Skill Format
22+
23+
Skills follow the [Agent Skills specification](https://agentskills.io/specification). The `SKILL.md` frontmatter must include:
24+
- `name` - Skill identifier (matches directory name)
25+
- `description` - Trigger description used by agents to decide when to activate the skill
26+
- `license`
27+
- `compatibility`
28+
- `allowed-tools`
29+
- `metadata.version` - Semver string
30+
31+
## Conventions
32+
33+
- Do not commit `.env` or secret files.
34+
- Reference docs in `references/` should be kept factual and up to date with the latest Chainlink documentation.
35+
- Eval cases go in `evals/<skill-name>/cases/` organized by category (`functional/`, `trigger-positive/`, `trigger-negative/`).

0 commit comments

Comments
 (0)