You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

68 lines
1.5 KiB
Markdown

6 months ago
# 发布检查清单
在提交到 Smithery 之前,请确保完成以下所有项目:
## 📋 文件检查
- [ ] README.md 完整且清晰
- [ ] LICENSE 文件存在
- [ ] Dockerfile 配置正确(推荐)
- [ ] pyproject.toml 配置正确(必需)
- [ ] requirements.txt 包含所有依赖
- [ ] smithery.yaml 配置正确
- [ ] server.py 可以正常运行
## 🧪 功能测试
- [ ] 服务器可以正常启动
- [ ] 所有工具都能正常调用
- [ ] 错误处理完善
- [ ] 返回结果格式正确
## 📝 文档检查
- [ ] 安装说明清晰
- [ ] 使用示例完整
- [ ] API 文档详细
- [ ] 支持的功能列表完整
## 🔧 配置检查
- [ ] pyproject.toml 中的 name 和 version 正确
- [ ] smithery.yaml 中的 name 唯一
- [ ] pyproject.toml 和 smithery.yaml 的 version 保持一致
- [ ] version 遵循语义化版本
- [ ] tools 列表完整
- [ ] homepage URL 正确
## 🚀 GitHub 准备
- [ ] 代码已推送到 GitHub
- [ ] 创建了 v1.0.0 标签
- [ ] 创建了 Release
- [ ] 仓库是 Public
## ✅ 最终检查
- [ ] 在本地测试通过
- [ ] 文档无拼写错误
- [ ] 所有链接可访问
- [ ] 准备好提交到 Smithery
## 提交步骤
1. 访问 https://smithery.ai/
2. 使用 GitHub 登录
3. 点击 "Submit Server"
4. 输入仓库 URL
5. 确认信息并提交
6. 等待审核1-3天
## 审核后
- [ ] 收到审核通过邮件
- [ ] 在 Smithery 上可以搜索到
- [ ] 测试安装和使用
- [ ] 分享给社区