Skip to content

Commit f295eb5

Browse files
authored
Merge pull request adobe#72 from adobe/issue/document-beta-skill-convention
docs: add beta skill convention to cloud-service and 6.5-lts CLAUDE.md
2 parents 3af0da4 + ca1bd65 commit f295eb5

2 files changed

Lines changed: 42 additions & 0 deletions

File tree

skills/aem/6.5-lts/CLAUDE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Conventions for this skill tree
2+
3+
## Beta skills
4+
5+
Skills that are not yet production-ready are marked with beta status using three mechanisms.
6+
All three must be applied together. To check whether a skill is beta, look for `status: beta`
7+
in its SKILL.md frontmatter.
8+
9+
1. **Frontmatter `status: beta`** -- machine-readable field for tooling
10+
2. **`[BETA]` prefix in `description`** -- visible to the LLM during skill selection,
11+
followed by a caveat line: "This skill is in beta. Verify all outputs before
12+
applying them to production projects."
13+
3. **Blockquote in body** -- visible to the LLM during skill execution:
14+
```
15+
> **Beta Skill**: This skill is in beta and under active development.
16+
> Results should be reviewed carefully before use in production.
17+
> Report issues at https://github.com/adobe/skills/issues
18+
```
19+
20+
When creating or modifying skills, preserve these markers. Do not remove beta
21+
status without explicit instruction.

skills/aem/cloud-service/CLAUDE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Conventions for this skill tree
2+
3+
## Beta skills
4+
5+
Skills that are not yet production-ready are marked with beta status using three mechanisms.
6+
All three must be applied together. To check whether a skill is beta, look for `status: beta`
7+
in its SKILL.md frontmatter.
8+
9+
1. **Frontmatter `status: beta`** -- machine-readable field for tooling
10+
2. **`[BETA]` prefix in `description`** -- visible to the LLM during skill selection,
11+
followed by a caveat line: "This skill is in beta. Verify all outputs before
12+
applying them to production projects."
13+
3. **Blockquote in body** -- visible to the LLM during skill execution:
14+
```
15+
> **Beta Skill**: This skill is in beta and under active development.
16+
> Results should be reviewed carefully before use in production.
17+
> Report issues at https://github.com/adobe/skills/issues
18+
```
19+
20+
When creating or modifying skills, preserve these markers. Do not remove beta
21+
status without explicit instruction.

0 commit comments

Comments
 (0)