Skip to content

repository-launch-checklist.md

Latest commit

 

History

History
165 lines (131 loc) · 5.25 KB

repository-launch-checklist.md

File metadata and controls

165 lines (131 loc) · 5.25 KB
Raw

GitHub Repository Launch Checklist

This checklist prepares L2MAS for GitHub discovery, sharing, and community contributions.

GitHub's own documentation highlights README quality, community profile files, topics, and citation metadata as useful repository signals. This repository includes those files and keeps the launch metadata below ready for the repository settings page.

Repository Identity

Field Recommended value
Repository name L2MAS
Full name Live2D Multi-Agent Animation System
Short description Live2D multi-agent animation prototype with MCP, A2A, provider routing, local AI, ComfyUI/Ollama/vLLM, and FFmpeg.
Homepage https://github.com/XucroYuri/L2MAS/releases/latest
Visibility Public, after final secret scan
License Apache-2.0
Default branch main
Discussions Enabled
Wiki Disabled

Suggested GitHub Topics

GitHub topics should describe purpose, subject area, community, and language. Use up to 20 focused topics:

live2d
vtuber
animation-generation
text-to-animation
generative-ai
ai-agents
multi-agent
mcp
model-context-protocol
a2a
agent-to-agent
provider-registry
local-ai
openai-compatible
ollama
vllm
comfyui
diffusers
ffmpeg
python

Social Preview Copy

Use this copy when creating a repository social preview image:

L2MAS
Live2D Multi-Agent Animation System
MCP + A2A + provider routing for cloud and local AI animation pipelines

Recommended image size: 1280 x 640 px. Keep the design high contrast, legible at small sizes, and free of third-party trademarks unless usage rights are clear.

The canonical source asset is ../assets/social-preview.svg. Export it to PNG before uploading it in GitHub repository settings.

Community Profile Files

Already present:

Discovery Files

Already present:

Final Local Checks

Run before creating the GitHub repository:

python3 -m json.tool config/a2a_config.json > /dev/null
python3 -m json.tool config/mcp_config.json > /dev/null
python3 -m json.tool config/provider_registry.example.json > /dev/null
docker compose config > /dev/null
python3 - <<'PY'
from pathlib import Path
import re

patterns = [
    re.compile("sk-" + r"[A-Za-z0-9_-]+"),
    re.compile("BEGIN " + r"(RSA|OPENSSH|EC|PRIVATE) KEY"),
    re.compile("GF_SECURITY_ADMIN_PASSWORD=" + "admin"),
]

hits = []
for path in Path(".").rglob("*"):
    if not path.is_file() or ".git" in path.parts:
        continue
    try:
        text = path.read_text(encoding="utf-8")
    except UnicodeDecodeError:
        continue
    for pattern in patterns:
        if pattern.search(text):
            hits.append(str(path))

if hits:
    raise SystemExit("Potential secret/default-password hits:\n" + "\n".join(hits))
PY

The final command should return no results.

Suggested Creation Command

After choosing the GitHub owner and confirming authentication:

gh repo create L2MAS \
  --public \
  --description "Live2D multi-agent animation prototype with MCP, A2A, provider routing, local AI, ComfyUI/Ollama/vLLM, and FFmpeg." \
  --source . \
  --remote origin \
  --push

After creation, set topics from the GitHub UI or with GitHub CLI if available:

gh repo edit XucroYuri/L2MAS \
  --description "Live2D multi-agent animation prototype with MCP, A2A, provider routing, local AI, ComfyUI/Ollama/vLLM, and FFmpeg." \
  --homepage "https://github.com/XucroYuri/L2MAS/releases/latest" \
  --enable-discussions=true \
  --enable-wiki=false \
  --remove-topic animation \
  --remove-topic docker \
  --remove-topic lip-sync \
  --remove-topic tts \
  --add-topic animation-generation \
  --add-topic model-context-protocol \
  --add-topic agent-to-agent \
  --add-topic openai-compatible

Discovery Maintenance

Detailed discovery metadata, labels, starter issue guidance, and social preview notes live in discovery-profile.md.

References