Thank you for your interest in contributing! This document provides guidelines for contributing to this project.
If you find a bug or have a feature request:
- Check if the issue already exists in the Issues section
- If not, create a new issue with:
- Clear title and description
- Steps to reproduce (for bugs)
- Expected vs actual behavior
- Your Home Assistant version
- Kettle firmware version (from
fellow_api.pyor integration logs) - Relevant logs or error messages
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Test your changes thoroughly
- Commit your changes (
git commit -m 'Add amazing feature') - Push to your branch (
git push origin feature/amazing-feature) - Open a Pull Request
- Follow existing code style and conventions
- Use meaningful variable and function names
- Add comments for complex logic
- Update documentation if adding new features
Before submitting:
- Test with an actual Stagg EKG+ kettle
- Verify all entities work correctly
- Check that temperature unit switching works
- Test power on/off functionality
- Ensure no errors in Home Assistant logs
If you add features, please update:
- README.md with usage examples
- KETTLE_SPECS.md if discovering new technical details
- PYTHON_API_EXAMPLES.md if adding API methods
- CHANGELOG.md with your changes
- Clone the repository
- Copy
custom_components/fellowto your HA config - Restart Home Assistant
- Add the integration with your kettle's IP
Feel free to open an issue for questions or discussions.
By contributing, you agree that your contributions will be licensed under the Unlicense.