Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
130 lines (94 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

130 lines (94 loc) · 2.72 KB
Raw

Contributing to OpenClaw WeChat Bot

感谢你对这个项目的兴趣！以下是参与贡献的指南。

🚀 如何贡献

报告问题

如果你发现了 bug 或有功能建议：

  1. 检查 Issues 是否已存在类似问题
  2. 如果不存在，创建一个新的 Issue
  3. 提供详细的信息：
    • 操作系统版本
    • Python 版本
    • 微信版本
    • 错误日志
    • 复现步骤

提交代码

  1. Fork 仓库

    git clone https://github.com/DSeaStar/openclaw-wechat-bot.git
cd openclaw-wechat-bot

  2. 创建分支

    git checkout -b feature/your-feature-name
# 或
git checkout -b fix/your-bug-fix

  3. 编写代码

    • 遵循 PEP 8 代码规范
    • 添加必要的注释
    • 更新相关文档

  4. 测试

    python -m py_compile your_script.py

  5. 提交更改

    git add .
git commit -m "feat: add new feature"
git push origin feature/your-feature-name

  6. 创建 Pull Request

📝 代码规范

Python 代码风格

  • 遵循 PEP 8
  • 使用 4 个空格缩进
  • 最大行长度：120 字符
  • 使用有意义的变量名

提交信息格式

使用 Conventional Commits：

feat: 添加新功能
fix: 修复 bug
docs: 更新文档
style: 代码格式调整
refactor: 重构代码
test: 添加测试
chore: 构建过程或辅助工具的变动

示例：

git commit -m "feat: 支持群聊 @ 功能"
git commit -m "fix: 修复引用消息无法识别的问题"
git commit -m "docs: 更新安装说明"

🎯 开发计划

高优先级

  • 支持更多微信消息类型（图片、语音、视频）
  • 添加 Web UI 管理界面
  • 支持多个 AI Agent 切换
  • 添加消息统计功能

中优先级

  • Docker 支持
  • 配置文件热重载
  • 更完善的错误处理
  • 单元测试覆盖

低优先级

  • 支持其他 AI 框架（除了 OpenClaw）
  • 聊天记录持久化
  • 多语言支持

🐛 已知问题

详见 Issues 页面。

💡 功能建议

如果你有新想法，欢迎：

  1. 先创建 Issue 讨论
  2. 在 Issue 中描述：
    • 功能是什么
    • 为什么需要这个功能
    • 如何实现（可选）

📞 联系方式

🙏 感谢

感谢所有贡献者！