mirror of https://github.com/ReScienceLab/opc-skills.git synced 2026-09-14 18:03:27 +08:00

Files

T

Yilin Jing 82e2cad26a refactor: Enhance skill versioning & release management with best practices

- AGENTS.md: Expanded Release Process with detailed single-skill and coordinated releases
  - Added breaking changes handling and compatibility testing guidelines
  - Included 3 release scenarios: quick release, coordinated release, breaking changes
  - Added release checklist for pre-merge verification

- CHANGELOG.md: Restructured with Compatibility & Dependency Matrix
  - Added matrix table showing skill versions and their dependencies
  - Reorganized version history by skill (vertical tracking)
  - Updated Unreleased sections with per-skill structure

- skills.json: Standardized dependencies with semantic versioning
  - Changed from simple array to semantic versioning format
  - domain-hunter: twitter >=1.0.0, reddit >=1.0.0
  - logo-creator, banner-creator: nanobanana >=1.0.0
  - seo-geo: twitter >=1.0.0, reddit >=1.0.0

- template/SKILL.md: Created comprehensive skill template
  - Includes updated frontmatter with semantic versioning dependencies
  - Documents dependency format and best practices
  - Provides guidance for skill creation

2026-01-21 20:12:05 +08:00

2.8 KiB

Raw Permalink Blame History

name, description, triggers, dependencies

name

description

triggers

dependencies

skill-name

Clear description of what this skill does and when to use it

trigger1

trigger2

another-trigger

dependency-skill	another-skill
>=1.0.0	>=2.0.0

Skill Name

Brief description of the skill and its purpose.

Prerequisites

List any setup requirements:

Environment variables needed
API keys required
Dependencies (already listed in frontmatter above)

Example setup:

export SKILL_API_KEY="your_api_key"

Quick Start

How to use the skill quickly:

cd <skill_directory>
python3 scripts/command.py --option value

Usage Examples

Example 1: Basic usage

python3 scripts/script.py "input"

Output:

Expected output here

Example 2: Advanced usage

python3 scripts/script.py "input" --flag --option value

Commands

All commands run from the skill directory.

Command 1

python3 scripts/script1.py --help
python3 scripts/script1.py "param1" --option value

Command 2

python3 scripts/script2.py "param1" "param2"

Scripts

script1.py - Description of what this script does
script2.py - Description of what this script does

API Info

Base URL: (if applicable)
Rate Limits: (if applicable)
Auth: (how authentication works)
Docs: Link to official documentation

Troubleshooting

Issue 1

Symptom: Description of the problem

Solution:

Step 1
Step 2

Issue 2

Symptom: Description of the problem

Solution:

Step 1
Step 2

Examples

See examples/ directory for full workflow examples.

References

Notes

Important note 1
Important note 2

Frontmatter Guide

The YAML frontmatter at the top of this file is required:

Field	Type	Required	Description
`name`	string	✓	Unique identifier (kebab-case)
`description`	string	✓	What the skill does and when to use it
`triggers`	array	✓	Keywords that activate this skill
`dependencies`	object		Dependent skills (format: `skill-name: ">=X.Y.Z"`)

Dependency Format

Use semantic versioning format:

"^1.0.0" - Compatible with 1.x versions
">=1.0.0" - Version 1.0.0 or higher
"1.0.0" - Exact version only
">=1.0.0,<2.0.0" - Range of versions

Creating Your Skill

Copy this template to skills/your-skill-name/
Update the YAML frontmatter
Write your SKILL.md documentation
Add Python/shell scripts in scripts/
Add usage examples in examples/
Update skills.json with your skill entry
Test with your agent before submitting PR

2.8 KiB Raw Permalink Blame History