docs: rewrite README and CONTRIBUTING for full registry scope

- README now covers all 5 content types (agents, hands, integrations, skills, providers)
- CONTRIBUTING has per-type instructions and checklists
- validate.py expanded to validate agents, hands, integrations, and skills
- PR template covers all content types
- Added new-content.yml issue template for non-model contributions
- CI workflow updated to Python 3.12
This commit is contained in:
Evan Hu committed 2026-03-21 02:10:12 +09:00
1 parent 17d32ed4a7
commit 1f3ef406ee
6 files changed
+639 -268

No files matched your search

+49
View File
@@ -0,0 +1,49 @@
name: New Content Request
description: Request addition of an agent, hand, integration, or skill
labels: ["new-content"]
body:
- type: dropdown
id: content_type
attributes:
label: Content Type
description: What type of content are you requesting?
options:
- Agent
- Hand
- Integration (MCP server)
- Skill
validations:
required: true
- type: input
id: name
attributes:
label: Name
description: The name/ID for this content.
placeholder: e.g. my-agent, browser, github
validations:
required: true
- type: textarea
id: description
attributes:
label: Description
description: What does this content do? Why is it useful?
placeholder: |
Describe the purpose and key capabilities.
validations:
required: true
- type: textarea
id: details
attributes:
label: Additional Details
description: |
Any extra context: required tools, external dependencies,
MCP server package, reference links, etc.
placeholder: |
- MCP server: @some/mcp-server
- Requires: API key from https://...
- Tools needed: web_search, file_read
validations:
required: false
+47 -9
View File
@@ -1,14 +1,52 @@
## Model Changes
## Content Type
### Added/Updated Models
- [ ] Model ID:
- [ ] Provider:
- [ ] Pricing verified from official source:
<!-- Check all that apply -->
### Checklist
- [ ] Agent (`agents/`)
- [ ] Hand (`hands/`)
- [ ] Integration (`integrations/`)
- [ ] Skill (`skills/`)
- [ ] Provider / Model (`providers/`)
- [ ] Other
## Changes
### Added/Updated
-
### Details
<!-- Brief description of what was added or changed -->
## Checklist
### General
- [ ] Content placed in the correct directory
- [ ] TOML files parse without errors
- [ ] Description is clear and concise
### Providers / Models (if applicable)
- [ ] `python scripts/validate.py` passes
- [ ] No duplicate model IDs
- [ ] Pricing is in USD per million tokens
- [ ] Pricing is in USD per million tokens and verified from official source
- [ ] Tier is one of: `frontier`, `smart`, `balanced`, `fast`, `local`
- [ ] `context_window` and `max_output_tokens` are positive integers
- [ ] Boolean fields (`supports_tools`, `supports_vision`, `supports_streaming`) are correct
### Agents (if applicable)
- [ ] `name` matches directory name
- [ ] System prompt provides clear instructions
- [ ] Tools list only includes required tools
### Hands (if applicable)
- [ ] `id` matches directory name
- [ ] `[agent]` section has complete system prompt
- [ ] `[[requires]]` lists external dependencies
- [ ] `[[settings]]` provides user-configurable options
### Integrations (if applicable)
- [ ] `[transport]` config tested locally
- [ ] `[[required_env]]` lists all needed variables
- [ ] `setup_instructions` are clear for first-time users
### Skills (if applicable)
- [ ] `[runtime].type` is correct
- [ ] `[input]` documents all parameters
- [ ] Prompt templates use correct `{{param}}` syntax
+3 -6
View File
@@ -1,4 +1,4 @@
name: Validate Catalog
name: Validate Registry
on:
push:
@@ -14,10 +14,7 @@ jobs:
- uses: actions/setup-python@v6
with:
python-version: "3.11"
python-version: "3.12"
- name: Install dependencies
run: pip install toml
- name: Validate catalog
- name: Validate registry
run: python scripts/validate.py