跳转到主要内容

​
欢迎贡献者！

感谢你有兴趣为 Mirobody Health 做贡献。本指南将帮助你快速开始。

​
贡献方式

新增 Providers

集成新的健康设备 Providers

修复 Bugs

反馈并修复问题

完善文档

改进与补充文档

新增功能

提出并实现新功能

​
开始贡献

1

Fork 仓库

Fork 一份你自己的 Mirobody Health 仓库
2

搭建开发环境

按照开发环境搭建进行配置
3

创建分支

git checkout -b feature/your-feature-name
4

完成修改

实现你的功能或修复
5

测试修改

pytest
6

提交并推送

git add .
git commit -m "Add: description of your changes"
git push origin feature/your-feature-name
7

创建 Pull Request

创建一个 Pull Request，并清晰描述你的改动内容

​
代码风格

  • Follow PEP 8 guidelines
  • Use black for code formatting
  • Use ruff for linting
  • Write docstrings for all public methods
  • Add type hints

​
Pull Request 规范

使用 conventional commit 格式：
  • feat: for new features
  • fix: for bug fixes
  • docs: for documentation
  • refactor: for code refactoring
  • test: for adding tests
  • 说明 PR 做了什么
  • 为什么需要这个改动
  • 如何测试这些改动
  • 链接相关 issues
  • 代码符合风格规范
  • 新增/更新测试
  • 更新文档
  • 所有测试通过
  • 无 linter warnings

​
有问题？

感谢你的贡献！