跳转到主要内容
欢迎来到 OpenYiDA！我们很高兴您有兴趣参与贡献。本指南涵盖了您需要的一切入门信息。

​
快速链接

​
维护者

名称角色GitHub
九神 (yize)核心架构、CLI 设计@yize
alex-mm功能开发、测试@alex-mm
nicky1108OpenClaw 集成、技能扩展@nicky1108

​
贡献方式

  1. 报告错误 → 开启 Issue 并附上复现步骤和环境信息
  2. 建议功能 → 先发起 Discussion 或 Issue，然后实现
  3. 改进文档 → 欢迎提交文档相关的 PR
  4. 添加技能 → 在 yida-skills/ 下扩展技能包
  5. 修复错误 / 新功能 → 遵循下方的开发工作流

​
开发环境设置

# 1. Fork 并克隆仓库
git clone git@github.com:your-username/openyida.git
cd openyida

# 2. 安装依赖
npm install

# 3. 全局链接以便本地调试
npm link

# 4. 运行测试
npm test

​
PR 检查清单

提交 pull request 前，请确认：
  • 已使用真实的 Yida 账号在本地测试相关功能
  • 所有测试通过：npm test
  • JS 语法检查通过： 
    node --check bin/yida.js && for f in lib/*.js lib/locales/*.js; do node --check "$f"; done
  • PR 描述清楚说明了变更内容和原因
  • 若有 UI/行为变更，附上截图或录制画面

​
PR 规范

  • 一个 PR 做一件事 — 勿混合不相关的变更
  • PR 标题格式： feat: add xxx / fix: fix xxx / docs: update xxx
  • 描述 应涵盖：做了什么、为何、如何测试
  • 若 PR 关闭了 Issue，请在描述中加上 Closes #123

​
提交规范

遵循 Conventional Commits： 
feat: add export-app command
fix: fix get-page-config path error
docs: update CLI command reference
refactor: refactor login module
test: add utils unit tests
chore: upgrade dependencies

​
代码风格

  • 遵循现有代码风格（CommonJS 模块，优先使用 Node.js 原生 API）
  • 变量和函数使用有意义的英文名称；避免缩写
  • 完整处理错误 — 勿静默吞掉异常
  • 添加新命令时，更新 README.md 中的 CLI 命令表格

​
欢迎 AI / Vibe-Coded PR！

完全欢迎由 Claude Code、Cursor、Aone Copilot 或任何其他 AI 工具辅助的 PR！请在 PR 描述中注明您使用的 AI 工具 — 这有助于维护者理解生成背景。

​
许可协议

通过贡献，您同意将您的贡献依据 MIT License 授权。