# Contribution Guidelines [English](./CONTRIBUTING.md) | [简体中文](./CONTRIBUTING_zh.md) Thank you for considering contributing to our project! We appreciate your efforts to make our project better. Before you start contributing, please take a moment to review the following guidelines. ## How Can I Contribute? ### Reporting Bugs If you encounter a bug in the project, please [open an issue](https://github.com/XiaoMi/ha_xiaomi_home/issues/new/) on GitHub and provide the detailed information about the bug, including the steps to reproduce the bug, the logs of debug level and the time when it occurs. The [method](https://www.home-assistant.io/integrations/logger/#log-filters) to set the integration's log level: ``` # Set the log level in configuration.yaml logger: default: critical logs: custom_components.xiaomi_home: debug ``` ### Suggesting Enhancements If you have ideas for enhancements or new features, you are welcomed to [start a discussion on ideas](https://github.com/XiaoMi/ha_xiaomi_home/discussions/new?category=ideas) on GitHub to discuss your ideas. ### Contributing Code 1. Fork the repository and create your branch from `main`. 2. Ensure that your code adheres to the project coding standard. 3. Make sure that your commit messages are descriptive and meaningful. 4. Pull requests should be accompanied by a clear description of the problem and the solution. 5. Update the documents if necessary. 6. Run tests if they are available and ensure they pass. ## Pull Request Guidelines Before submitting a pull request, please make sure that the following requirements are met: - Your pull request addresses a single issue or feature. - You have tested your changes locally. - Your code follows the project's [code style](#code-style). Run [`pylint`](https://github.com/google/pyink) over your code using this [pylintrc](../.pylintrc). - All existing tests pass, and you have added new tests if applicable. - Any dependent changes are documented. ## Code Style We follow [Google Style](https://google.github.io/styleguide/pyguide.html) for code style and formatting. Please make sure to adhere to this guideline in your contributions. ## Commit Message Format ``` :