ARTICLE DETAIL

资讯详情

深耕网站建设与运营推广的一线实战洞察。

如何为AlphaGBM Skills贡献代码:从mock数据到提交PR的完整开发者指南

如何为AlphaGBM Skills贡献代码:从mock数据到提交PR的完整开发者指南 如何为AlphaGBM Skills贡献代码从mock数据到提交PR的完整开发者指南【免费下载链接】skillsBring realtime market data and research workflows into Claude Code, Cursor beyond — 29 open-source Skills for stocks, options and commodities.项目地址: https://gitcode.com/gh_mirrors/skills38/skillsAlphaGBM Skills 是一个开源的 AI 市场研究技能库提供 29 个面向股票、期权和商品的 Skills可接入 Claude Code、Cursor 等 AI 工作区。本文是一份面向新手贡献者的完整开发者指南讲解如何理解仓库结构、编写 mock 数据、生成 Skill 文档并按流程提交一个合格的 Pull Request。上图展示了 AlphaGBM Skills 在 AI 工作区中的典型输出一条命令、结构化 JSON、证据优先的工作流。你贡献的每一个 Skill最终都会呈现为这样的结果。先了解仓库结构你的代码放在哪里AlphaGBM Skills 采用目录即源码、生成物不手改的设计。理解以下三块内容就能看懂整个贡献流程模块路径作用贡献指南CONTRIBUTING.md贡献方式、PR 流程与开发环境搭建目录清单catalog/catalog.json唯一的可编辑源所有 Skill 元数据在这里定义生成脚本scripts/build_catalog.py从 catalog 生成各 Skill 的 SKILL.md、runner 脚本和目录文档共享运行器runtime/workflow.py每个 Skill 内置的 Python 运行脚本来源测试scripts/test_catalog.py校验生成物是否与 catalog 一致、demo 夹具是否合规一个典型的 Skill 目录如 skills/alphagbm-stock-analysis/包含SKILL.md—— AI 实际读取的技能定义由脚本生成scripts/run.py—— 自包含的 Python 3.9 运行器由脚本生成references/access.md—— 访问与证据规则由脚本生成关键原则不要手改skills/skill-name/下由脚本生成的文件。正确做法是修改 catalog/catalog.json再运行python3 scripts/build_catalog.py重新生成。最快的本地开发环境搭建只需 Python 3.9 和 Node.js用于 npx 校验。本地只需 3 条命令克隆仓库后进入目录运行python3 scripts/build_catalog.py生成全部 Skill 文档运行python3 scripts/build_catalog.py --check确认生成物与 catalog 一致--check模式会逐文件比对如果任何生成文件过期stale会以非零状态退出并列出文件清单——这也是你在提交前必须跑通的一道关卡。如何贡献 mock 数据新手的最佳起点项目中最容易上手、也最欢迎的贡献类型是mock 数据。mock 数据是带日期标注的示例样本用于演示输出结构永远不会被 runner 用来替代真实的失败请求。已有样本AAPL、NVDA、SPY、TSLA、META如 mock-data/AAPL.json以及若干单策略示例如 mock-data/fear-score/example-calm.json。添加新行情 mock 数据的步骤按照 CONTRIBUTING.md 的规范选择一个尚未覆盖的 ticker当前已覆盖 AAPL、NVDA、SPY、TSLA、META在mock-data/TICKER/下添加真实的 JSON 数据参照 mock-data/AAPL.json 的现有格式必须包含股票报价、期权链至少 2 个到期日、IV 历史所有数字必须真实可信、内部一致以 mock-data/AAPL.json 为例一份合格的样本包含stock报价与技术指标、optionsIV 期限结构、波动率曲面、含 Greeks 的链样本、示例策略、earnings_history财报 IV crush 历史和market_sentiment等区块且带snapshot_date日期字段——这正是内部一致的要求。⚠️ 注意mock 数据是可选的、必须被明确请求并标注的。它不是占位结果PR 里要能说清它对应的 ticker 和日期。如何改进现有 Skill每个 Skill 的改动都应走改源、生成、测试三步创建分支git checkout -b improve/skill-name修改 catalog/catalog.json 中的描述、输出字段或示例提示词运行python3 scripts/build_catalog.py重新生成在 Claude Code 或 Cursor 中实测该 Skill提交 PR并附上改进前后的对比示例scripts/test_catalog.py 中的测试用例值得细读它定义了项目对合格的判断标准例如test_all_generated_artifacts_match所有生成物必须与 catalog 完全一致test_every_strategy_has_an_explicit_demo_fixture每个策略必须带显式的 demo 夹具且标注illustrative_fixture、notForTradingtest_new_packages_are_standalone新包必须独立可运行--help不需要 API keydemo 夹具的规范说明见 demo/README.md策略夹具位于 demo/strategies/如 demo/strategies/grid-plan.json。提交PR前的检查清单CONTRIBUTING.md 给出了官方 PR Checklist逐项对照再提交Skill 输出准确、可验证mock 数据真实可信不是随机数字SKILL.md 遵循现有格式不包含 API key、密钥或个人数据至少在一个 AI agent 环境中测试通过一个 PR 只做一个 Skill 或一个修复Keep it focused此外还有两条项目特有的红线只读包不得声称拥有实时 API 能力——reference-only 包新增接口时必须同时提供访问契约和失败/用法检查见 docs/ACCESS.md本地包测试前安装到隔离的测试项目绝不覆盖贡献者自己的全局 AI 配置版本记录与社区协作习惯查看 docs/CHANGELOG.md 可以了解项目如何组织发布每次改动都会以带日期的条目说明重构了什么、边界如何澄清、兼容性如何保持。你的 PR 描述也建议采用同样的风格——写清改了什么、为什么、边界在哪。社区沟通渠道Discord、GitHub Discussions在 CONTRIBUTING.md 末尾有说明项目遵循 Contributor Covenant 行为准则。PR 通常会在几天内完成评审请耐心等待。总结贡献路径一图流你的水平推荐起点涉及模块纯新手添加 mock 数据mock-data/熟悉 Python改进 demo 夹具与测试demo/strategies/、scripts/熟悉 Skill 机制改进/新增 Skillcatalog/catalog.json build_catalog.py记住三条核心纪律改源不改进生成物改 catalog跑脚本、mock 数据必须真实且有日期、提交前跑通--check。做到这三点你的第一个 PR 大概率能顺利通过评审。 【免费下载链接】skillsBring realtime market data and research workflows into Claude Code, Cursor beyond — 29 open-source Skills for stocks, options and commodities.项目地址: https://gitcode.com/gh_mirrors/skills38/skills创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表