如何贡献新技能Erduo Skills开发者贡献规范与最佳实践【免费下载链接】erduo-skills项目地址: https://gitcode.com/gh_mirrors/er/erduo-skillsErduo Skills是一个开源项目旨在为开发者提供一个贡献和分享技能的平台。无论你是新手还是有经验的开发者都可以通过贡献新技能来丰富这个项目。本文将详细介绍贡献新技能的规范和最佳实践帮助你快速上手并提交高质量的技能代码。技能目录结构规范每个技能都应遵循统一的目录结构这样不仅便于项目维护也能让其他开发者快速理解你的技能实现。以下是标准的技能目录结构skills/ your-skill-name/ agents/ # 存放代理配置文件如openai.yaml references/ # 存放参考文档、配置文件等 scripts/ # 存放技能实现的脚本文件 SKILL.md # 技能描述文档必须包含 package.json # 如有依赖需提供此文件以现有的ak-rss-digest技能为例其目录结构如下agents/openai.yamlOpenAI代理配置references/feeds.opmlRSS源配置文件scripts/fetch_today_feed_items.py核心功能脚本SKILL.md技能详细说明文档SKILL.md编写指南SKILL.md是技能的核心文档必须包含以下内容技能元数据文件开头需用---包裹技能元数据包括name和description--- name: your-skill-name description: 简要描述你的技能功能和用途 ---技能详细内容元数据之后应包含以下章节Overview简要介绍技能的用途和使用场景Workflow详细描述技能的工作流程Resources列出技能使用的资源文件路径Command Examples提供使用示例命令以anthropic-style-diagram技能为例其SKILL.md包含了Workflow、Rendering、Authoring contract等详细章节清晰地说明了如何使用该技能绘制Anthropic风格的图表。代码实现最佳实践脚本文件规范脚本文件应放在scripts/目录下文件名应清晰反映其功能如fetch_today_feed_items.py、url_to_markdown.mjs对于Python脚本建议提供requirements.txt说明依赖对于Node.js脚本建议提供package.json和package-lock.json依赖管理尽量使用项目已有的依赖库减少新增依赖如必须新增依赖需在package.json或requirements.txt中明确指定版本对于Node.js项目运行npm install安装依赖如cd skills/anthropic-style-diagram npm install错误处理对网络请求、文件操作等可能失败的操作需添加适当的错误处理网络请求失败时应考虑是否可继续执行或优雅退出如ak-rss-digest技能中处理feed-level network failures的方式贡献步骤1. 克隆仓库首先克隆项目仓库到本地git clone https://gitcode.com/gh_mirrors/er/erduo-skills2. 创建技能目录在skills/目录下创建你的技能目录如my-new-skill并按照上述目录结构添加必要的文件。3. 实现技能功能编写SKILL.md文档和相关脚本确保代码可运行且符合项目规范。可以参考现有技能如web-to-markdown的实现方式其scripts/url_to_markdown.mjs是一个很好的示例。4. 测试技能在本地测试你的技能确保其功能正常。例如对于Node.js脚本可以运行node scripts/your-script.mjs5. 提交贡献提交你的代码并创建Pull Request等待项目维护者审核。技能质量检查清单在提交贡献前请检查以下事项目录结构符合规范SKILL.md包含必要的元数据和章节代码有适当的注释已测试技能功能确保可正常运行依赖管理清晰没有冗余或不必要的文件常见问题解答Q: 技能可以使用哪些编程语言A: 目前项目中包含Python和Node.js脚本建议使用这两种语言之一以便与现有项目保持一致。Q: 如何处理技能所需的API密钥A: 敏感信息如API密钥不应硬编码在代码中建议通过环境变量或配置文件读取并在SKILL.md中说明如何设置。Q: 我的技能需要前端界面怎么办A: Erduo Skills目前主要关注后端技能实现如有前端需求可在SKILL.md中说明并提供相关的前端资源路径。通过遵循以上规范和最佳实践你可以为Erduo Skills项目贡献高质量的新技能。无论是RSS摘要生成、网页转Markdown还是图表绘制你的每一个贡献都将使这个项目更加丰富和实用。开始你的贡献之旅吧【免费下载链接】erduo-skills项目地址: https://gitcode.com/gh_mirrors/er/erduo-skills创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考