# 贡献指南感谢您考虑为我们的项目做出贡献！您的努力将使我们的项目变得更好。在您开始贡献之前，请花一点时间阅读以下准则： ## 我可以如何贡献？ ### 报告问题如果您在项目中遇到错误，请在 GitHub 上[报告问题](https://github.com/sususweet/midea_auto_cloud/issues/new/)，并提供关于错误的详细信息，包括复现步骤、 debug 级日志以及错误出现的时间。集成开启 debug 级日志的[方法](https://www.home-assistant.io/integrations/logger/#log-filters)： ``` # configuration.yaml 设置打印日志等级 logger: default: critical logs: custom_components.xiaomi_home: debug ``` ### 建议增强功能如果您有增强或新功能的想法，欢迎您在 GitHub 讨论区[创建想法](https://github.com/sususweet/midea_auto_cloud/discussions/new?category=ideas) 。我们期待您的建议！ ### 贡献代码 1. Fork 该仓库并从 `master` 创建您的分支。 2. 确保您的代码符合项目的编码规范。 3. 确保您的提交消息描述清晰。 4. 提交请求应附有明确的问题描述和解决方案。 5. 如果必要，请更新文档。 6. 请运行测试并确保测试通过。 ## 适配设备要适配本项目中暂未包含的设备，可以按照以下步骤进行： 1. 在Homeassistant中安装本插件，安装完成后登录自己的账号，可以看到自己名下的设备。 2. 在集成中找到需要适配的设备，点击设备的相关字段进入详情页面，如下图： ![img_2.png](./img/img_2.png) 3. 点击传感器中的`连通性`，可以看到该设备可以被读取和访问的状态，如下图： ![img_3.png](./img/img_3.png) 着重关注Device type、Subtype这两个字段，这是后续获得设备控制对应lua文件的基础。 4. 进入Homeassistant的安装目录，在`.storage/midea_auto_cloud/lua/`目录下找到T_0000_`Device type`_`Subtype`_***.lua文件，例如上面干衣机设备的lua文件是： T_0000_DC_12852_2021121701.lua。 5. 可用人工分析或者AI分析的方法解析lua文件，结合美的官方APP的控制界面，提取出需要控制的设备属性，把修改合并到`device_mapping`中对应设备`Device type`的py文件中。 6. `device_mapping`中设备映射文件的编写方法可参考之前编写过的，`default`是默认的映射，可以作为参考，默认改这个就可以。如果自己设备的映射跟通用的差别太大（目前发现有空调、新风系统设备类型都是T0xAC，但可控制的变量差别比较大），可以根据设备的sn8来新建字段。 7. 完成上述步骤，编写好`device_mapping`中对应设备的py文件，即可在自己的机器上测试，测试好后就可以提pr。 ## 拉取请求准则在提交拉取请求之前，请确保满足以下要求： - 您的拉取请求解决了单个问题或功能。 - 您已在本地测试过您的更改。 - 您的代码遵循项目的代码规范。 - 所有现有测试都通过，并且如果适用，您已添加了新的测试。 - 任何依赖更改都有文档说明。 ## 代码规范本项目的代码格式遵循 [Google Style](https://google.github.io/styleguide/pyguide.html) 。请确保您的贡献符合该指南。 ## Commit Message 格式 ``` :