Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 1.64 KB

File metadata and controls

95 lines (67 loc) · 1.64 KB

贡献指南

感谢你对 RQData CLI 的关注。

问题与功能请求

  • Bug 报告请使用 GitHub Issues
  • 新功能建议也请先在 GitHub Issues 讨论
  • 提交问题时请包含复现步骤、预期行为、实际行为、运行环境和关键日志

本地开发

git clone https://github.com/ricequant/rqdata-cli.git
cd rqdata-cli

构建:

VERSION=dev ./build.sh

验证:

./rqdata --help
./rqdata --version

如果需要验证 npm 分发链路:

npm run build:npm
npm run link:platform
node bin/rqdata.js --version

提交流程

  1. Fork 仓库并创建分支
  2. 完成修改并更新相关文档
  3. 确认构建通过
  4. 提交清晰的 commit message
  5. 发起 Pull Request

推荐的提交前缀:

  • feat: 新功能
  • fix: Bug 修复
  • docs: 文档更新
  • refactor: 重构
  • test: 测试相关
  • chore: 构建或工具调整

代码约定

  • 使用 Go 1.21+
  • 保持命令行行为向后兼容
  • 新增功能时同步更新 README 或相关文档
  • 尽量保持输出格式稳定,避免破坏脚本或 Agent 集成

发布

npm 发布采用“主包 + 平台包”模式:

  • @ricequant2026/rqdata-cli
  • @ricequant2026/rqdata-cli-linux-x64
  • @ricequant2026/rqdata-cli-darwin-x64
  • @ricequant2026/rqdata-cli-darwin-arm64
  • @ricequant2026/rqdata-cli-win32-x64

本地打包:

npm run pack:all

发布:

npm run publish:all

预发布测试:

npm version prerelease --preid rc
npm run publish:next

获取帮助