# 贡献指南 [English](../CONTRIBUTING.md) | [简体中文](./CONTRIBUTING_zh.md) 感谢您考虑为我们的项目做出贡献！您的努力将使我们的项目变得更好。在您开始贡献之前，请花一点时间阅读以下准则： ## 我可以如何贡献？ ### 报告问题如果您在项目中遇到错误，请在 GitHub 上[报告问题](https://github.com/XiaoMi/ha_xiaomi_home/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/XiaoMi/ha_xiaomi_home/discussions/new?category=ideas) 。我们期待您的建议！ ### 贡献代码 1. Fork 该仓库并从 `main` 创建您的分支。 2. 确保您的代码符合项目的编码规范。 3. 确保您的提交消息描述清晰。 4. 提交请求应附有明确的问题描述和解决方案。 5. 如果必要，请更新文档。 6. 请运行测试并确保测试通过。 ## 拉取请求准则在提交拉取请求之前，请确保满足以下要求： - 您的拉取请求解决了单个问题或功能。 - 您已在本地测试过您的更改。 - 您的代码遵循项目的[代码规范](#代码规范)，已运行 [`pylint`](https://github.com/google/pyink) 搭配本项目的 [pylintrc](../.pylintrc) 检查代码。 - 所有现有测试都通过，并且如果适用，您已添加了新的测试。 - 任何依赖更改都有文档说明。 ## 代码规范本项目的代码格式遵循 [Google Style](https://google.github.io/styleguide/pyguide.html) 。请确保您的贡献符合该指南。 ## Commit Message 格式 ``` :