反馈与贡献¶

感谢你使用 UltraFlow！你的反馈和贡献让这个项目变得更好。

📢 我们想听到你的声音¶

使用反馈¶

无论你的使用体验如何，我们都想听到你的声音：

遇到问题？

描述问题现象
提供复现步骤
附上错误信息
告诉我们你的环境 (OS、Python 版本)

功能建议？

你希望实现什么功能
这个功能的使用场景
你的实现思路 (如果有)

使用心得？

你用 UltraFlow 做了什么
解决了什么问题
有什么改进建议

反馈渠道¶

GitHub Issues(推荐)：https://github.com/enthusa/UltraFlow/issues

适合：bug 报告、功能建议

GitHub Discussions：https://github.com/enthusa/UltraFlow/discussions

适合：使用心得、经验分享、问题讨论

🎯 常见反馈场景¶

场景 1：发现 Bug¶

好的 bug 报告示例：

**问题描述**
运行 `uf run` 命令时提示找不到配置文件

**复现步骤**
1. 运行 `uf init my_project`
2. 进入 my_project 目录
3. 运行 `uf new test_flow`
4. 运行 `uf run test_flow`
5. 报错：Connection config file not found

**预期行为**
应该能找到配置文件并正常执行

**实际行为**
提示找不到配置文件

**环境信息**
- OS: macOS 14.0
- Python: 3.9.13
- UltraFlow: 0.1.0

**错误信息**

FileNotFoundError: Connection config file not found.

场景 2：功能建议¶

好的功能建议示例：

**功能描述**
希望支持从环境变量读取 API Key

**使用场景**
在 CI/CD 环境中，不方便将 API Key 写入配置文件。
希望能通过环境变量 OPENAI_API_KEY 传入。

**建议实现**
在 `_select_connection_by_model` 方法中，
先检查环境变量，如果存在则优先使用。

**是否愿意实现**
可以尝试提交 PR

场景 3：使用心得¶

好的使用心得示例：

**应用场景**
用 UltraFlow 批量翻译技术文档 (1000+ 篇)

**使用体验**
- prompty 格式很方便，可以快速调整提示词
- 多线程处理大大提高了效率
- 追踪功能帮助我找到了提示词的问题

**改进建议**
- 希望能显示剩余时间估计
- 希望能自动重试失败的请求
- 希望能导出为 CSV 格式

**推荐指数**
⭐⭐⭐⭐⭐

🤝 如何贡献¶

贡献方式¶

你可以通过多种方式贡献：

1. 代码贡献

修复 bug
实现新功能
优化性能
改进错误处理

2. 文档贡献

修正错误
补充说明
添加示例
翻译文档

3. 社区贡献

回答问题
分享经验
撰写教程
推广项目

快速开始¶

第一次贡献？

⭐ 给项目加星
让更多人看到这个项目
鼓励维护者继续开发
📖 阅读文档
参与开发了解贡献流程
代码规范了解编码标准
🔍 寻找任务
查看 Good First Issue
从简单的文档改进开始
💬 介绍自己
在 Discussions 中打个招呼
说说你的兴趣和技能

需要帮助？

在 Issues 中提问
在 Discussions 中讨论
查看已有的 Issues 和 PR

我们会尽快回复并提供帮助！

📊 贡献统计¶

你的每一个贡献都会被记录：

代码贡献：显示在 Contributors 列表
Issue 和 PR：计入 GitHub 活动
文档改进：标注在 Commit 历史

🎁 致谢¶

特别感谢所有贡献者：

提出 Issue 的用户
提交 PR 的开发者
改进文档的编写者
分享经验的社区成员

是你们让 UltraFlow 变得更好！

常见问题¶

Q：我不会写代码，可以贡献吗？¶

A：当然可以！非代码贡献同样重要：

改进文档
报告 bug
提出建议
回答问题
分享经验

Q：我的 PR 会被采纳吗？¶

A：只要符合以下条件，通常会被采纳：

解决了实际问题
代码质量良好
通过了测试
更新了文档

如果不确定，可以先开 Issue 讨论。

Q：多久能得到回复？¶

A：我们会尽快回复，通常在：

Issues：1-3 天内
PR：3-7 天内
Discussions：1-2 天内

如果超过一周没有回复，请 @ 维护者。

Q：可以提交未完成的 PR 吗？¶

A：可以！使用 Draft PR 标记为草稿：

早期获得反馈
避免重复工作
讨论实现方案

Q：如何提高 PR 被接受的概率？¶

A：遵循最佳实践：

先开 Issue 讨论想法
保持 PR 小而专注
添加测试用例
更新相关文档
遵循代码规范

再次感谢你对 UltraFlow 的支持！ 🙏

你的每一个反馈和贡献都在推动这个项目前进。让我们一起把 UltraFlow 打造成最好用的提示词工程工具！