参与贡献

概述

CLI-Anything 是一个开源项目，欢迎所有人参与贡献。无论你是开发者、文档作者还是测试者，都能为项目做出贡献。

🚀 快速贡献

提交 Pull Request

最直接的贡献方式是提交 PR。请先阅读官方贡献指南：

👉 CONTRIBUTING.md

基本流程：

Fork 仓库
创建分支：git checkout -b feature/your-feature
开发与测试：确保所有测试通过（pytest）
提交 PR：描述清楚改动内容和目的

📋 请求新 CLI 支持（Wishlist）

如果你希望 CLI-Anything 支持某个新软件，请提交 Wishlist 请求。

请求模板

在 GitHub Issue 中使用以下模板：

## 软件名称
[软件名称]

## 软件官网
[官网链接]

## 为什么需要
[描述你的使用场景和需求]

## 可用 API/接口信息
- [ ] 有官方 API
- [ ] 有 Python 绑定
- [ ] 有命令行接口
- [ ] 有插件系统
- [ ] 其他：[说明]

## 操作系统
- [ ] Windows
- [ ] macOS
- [ ] Linux

👤 贡献者注册

如果你想成为长期贡献者，请使用贡献者注册模板：

## 昵称/ID
[你的 GitHub 用户名]

## 擅长领域
- [ ] Python 开发
- [ ] 某软件的深度使用（请说明）
- [ ] 文档编写
- [ ] 测试

## 愿意负责的 CLI
[列出你愿意帮助开发/维护的 CLI 工具]

## 可投入时间
[每周大约多少小时]

🔧 技术贡献指南

添加新 CLI 的流程

分析目标软件：研究其 API、插件系统或自动化接口
设计命令结构：遵循 CLI-Anything 的命令设计规范
生成 CLI 代码：通过 7 阶段生成器自动生成
编写测试：确保单元测试和 E2E 测试全部通过
生成 SKILL.md：Phase 6.5 自动生成 Agent 技能描述文件
提交 PR：附带完整的测试结果

SKILL.md 生成（Phase 6.5）

每个 CLI 工具都需要配套的 SKILL.md 文件，这是 AI Agent 理解和使用工具的关键。Phase 6.5 会自动生成此文件，内容包括：

工具概述：CLI 工具的功能描述
安装说明：如何安装和配置
命令参考：所有可用命令和参数
使用示例：常见的使用场景和命令组合
注意事项：已知限制和最佳实践

统一的技能目录结构

所有生成的 CLI 技能文件统一放置在项目根目录的 skills/ 目录下：

skills/
├── gimp/
│   └── SKILL.md
├── blender/
│   └── SKILL.md
├── freecad/
│   └── SKILL.md
└── ...

这种统一的结构便于 Agent 平台发现和加载技能。

📝 文档贡献

文档改进也是重要的贡献方式：

🇨🇳 中文翻译：帮助完善中文文档
📖 教程编写：创建使用教程和最佳实践指南
🐛 文档修正：修复文档中的错误或过时信息
💡 示例补充：添加更多使用示例

🧪 测试贡献

测试覆盖是 CLI-Anything 质量的保障：

运行测试：pytest tests/
报告 Bug：发现问题时提交 Issue
补充测试：为边界情况添加测试用例

项目目前拥有 2,269+ 个测试用例，100% 通过率。我们希望继续保持这个标准。

📜 贡献者权益

你的名字会出现在贡献者列表中
你维护的 CLI 会标注你的贡献
社区荣誉和认可

🔗 相关链接

GitHub 仓库：HKUDS/CLI-Anything
问题追踪：GitHub Issues
贡献指南：CONTRIBUTING.md
行为准则：请遵循社区行为准则，保持友善和尊重

感谢你对 CLI-Anything 项目的关注和支持！每一个贡献都让 AI Agent 离操控任意软件更近一步。🎉