Contributing

We welcome contributions to this project!

How to Contribute

• Bug Reports: Create an issue
• Questions & Help: Start a Q&A discussion
• Feature Requests: Share an idea
• Lovelace & Automations: Show your project
• Pull Requests: Fork → Branch → Changes → PR
• Documentation: Improve wiki pages or add new ones
• Translations: Help with DE/EN translations

Development Environment Setup

1. Fork the repository
2. Clone the fork locally
3. Copy custom_components/idm_heatpump/ to your HA custom_components/ directory
4. Enable debug logging
5. Restart HA

Language

The project writes in English: code, comments, documentation, changelog entries, commit messages and pull request descriptions. German belongs only in README_de.md and in the Home Assistant de translations. Run python scripts/check_documentation_language.py before opening a pull request — tests/test_documentation_language.py fails the build on German prose.

Code Style

• Use Ruff for linting and formatting
• Follow Conventional Commits for commit messages
• Keep the code simple and understandable

Pull Request Process

1. Create a fork
2. Create a feature branch (git checkout -b feat/my-feature)
3. Commit your changes (git commit -m 'feat: add my feature')
4. Push to the fork (git push origin feat/my-feature)
5. Create a Pull Request

License

By contributing, you agree that your code will be published under the MIT License.