templates/experiment-skill-template/EXPRIMENT_NAME

experiment-log.md

Experiment Log: EXPERIMENT_NAME

Experiment Records

YYYY-MM-DD

Objective

Execution

Results

Next Steps

---

YYYY-MM-DD (Additional Date)

...

plugin.json

{
  "name": "EXPERIMENT_NAME",
  "version": "1.0.0",
  "description": "EXPERIMENT_DESCRIPTION",
  "author": {
    "name": "AUTHOR_NAME"
  },
  "skills": "./skills",
  "repository": "https://github.com/sionic-ai/sionic-research-skills"
}

SKILL.md

name	description
EXPERIMENT_NAME	[Experiment Type] Skill. Usage: (1) [Scenario 1], (2) [Scenario 2], (3) [Scenario 3]. Tested on [Verification Model/Environment].

EXPERIMENT_NAME - Research Note

Experiment Overview

Item	Details
Date	YYYY-MM-DD
Researcher
Objective
Model
Dataset
Environment	GPU: / Memory:

---

Verified Workflow

Step 1: [Step Name]

[Specific execution method. Include commands and code]

# Example command

Step 2: [Step Name]

[Description of next step]

Step 3: [Step Name]

[Continue...]

---

Key Findings

What Worked

Item	Setting/Method	Result	Remarks

Failed Attempts (Very Important!)

Attempt	Reason for Failure	Lesson Learned

---

Verified Hyperparameters

# Settings ready to copy and use
model:
  name:

training:
  learning_rate:
  batch_size:
  epochs:
  warmup_steps:

optimization:
  # ...

---

Precautions

• Must Check:
• Common Mistakes:
• Environment Dependencies:

---

Environment for Reproduction

Required Packages

pip install transformers==X.X.X
pip install torch==X.X.X
# ...

Hardware Requirements

• GPU:
• VRAM:
• RAM:

---

Script Usage

# 1. [First Step]
python scripts/script1.py --arg value

# 2. [Second Step]
python scripts/script2.py --arg value

---

Related Files

• scripts/: Reusable experiment code
• references/experiment-log.md: Detailed experiment log
• references/hyperparameters.md: History of hyperparameters
• references/troubleshooting.md: Troubleshooting cases

---

Next Steps / TODO

• [ ]
• [ ]

---

References

• Paper/Document Link
• Related Code

troubleshooting.md

Troubleshooting Log: EXPERIMENT_NAME

Issue 1: [Issue Title]

Symptoms

[Error message or phenomenon]

Cause

Solution

# or code

References

---

Issue 2: [Issue Title]

Symptoms

Cause

Solution

---

FAQ

Q:

A:

Q:

A:

update-marketplace.yml

name: Update Marketplace

on:
  push:
    branches: [main]
    paths:
      - 'plugins/**'
  pull_request:
    branches: [main]
    paths:
      - 'plugins/**'

permissions:
  contents: write
  pull-requests: write

jobs:
  update-marketplace:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4
        with:
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      - name: Generate marketplace.json
        run: python scripts/generate_marketplace.py

      - name: Check for changes
        id: git-check
        run: |
          git diff --exit-code .claude-plugin/marketplace.json || echo "changed=true" >> $GITHUB_OUTPUT

      - name: Commit and push (main branch only)
        if: github.ref == 'refs/heads/main' && steps.git-check.outputs.changed == 'true'
        run: |
          git config --local user.email "github-actions[bot]@users.noreply.github.com"
          git config --local user.name "github-actions[bot]"
          git add .claude-plugin/marketplace.json
          git commit -m "chore: marketplace.json 자동 업데이트

          [skip ci]"
          git push

      - name: Comment on PR (pull request only)
        if: github.event_name == 'pull_request' && steps.git-check.outputs.changed == 'true'
        uses: actions/github-script@v7
        with:
          script: |
            const fs = require('fs');
            const marketplace = JSON.parse(fs.readFileSync('.claude-plugin/marketplace.json', 'utf8'));

            const plugins = marketplace.plugins.map(p =>
              `- **${p.name}** (${p.category || 'unknown'}): ${p.description.substring(0, 80)}...`
            ).join('\n');

            const body = `## 🔄 Marketplace 업데이트 감지

            이 PR이 머지되면 marketplace.json이 자동으로 업데이트됩니다.

            ### 등록된 플러그인 (${marketplace.plugins.length}개)

            ${plugins}

            ---
            *이 코멘트는 자동으로 생성되었습니다.*`;

            github.rest.issues.createComment({
              issue_number: context.issue.number,
              owner: context.repo.owner,
              repo: context.repo.repo,
              body: body
            });

validate-plugins.yml

name: Validate Plugins

on:
  pull_request:
    branches: [main]
    paths:
      - 'plugins/**'

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.11'

      - name: Validate plugin structure
        run: python scripts/validate_plugins.py

      - name: Check SKILL.md exists
        run: |
          echo "Checking SKILL.md files..."
          errors=0

          for plugin_json in $(find plugins -name "plugin.json" -path "*/.claude-plugin/*"); do
            plugin_dir=$(dirname $(dirname "$plugin_json"))
            plugin_name=$(jq -r '.name' "$plugin_json")

            # skills 폴더 확인
            if [ ! -d "$plugin_dir/skills" ]; then
              echo "❌ Missing skills/ folder: $plugin_dir"
              errors=$((errors + 1))
              continue
            fi

            # SKILL.md 확인
            skill_md=$(find "$plugin_dir/skills" -name "SKILL.md" | head -1)
            if [ -z "$skill_md" ]; then
              echo "❌ Missing SKILL.md: $plugin_dir"
              errors=$((errors + 1))
            else
              echo "✅ $plugin_name: $skill_md"
            fi
          done

          if [ $errors -gt 0 ]; then
            echo ""
            echo "Found $errors errors"
            exit 1
          fi

          echo ""
          echo "All plugins validated successfully!"