Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (35 loc) · 1.31 KB

CONTRIBUTING.md

File metadata and controls

48 lines (35 loc) · 1.31 KB

Contributing to Pace BMS Integration

Thank you for your interest in contributing to the Pace BMS integration!

How to Contribute

Reporting Bugs

  1. Check if the issue already exists in Issues
  2. If not, create a new issue using the bug report template
  3. Include:
    • Home Assistant version
    • Integration version
    • BMS model and connection type
    • Relevant logs from Settings → System → Logs
    • Steps to reproduce

Suggesting Features

  1. Check existing feature requests
  2. Create a new issue using the feature request template
  3. Clearly describe the use case and expected behavior

Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature/fix
  3. Make your changes
  4. Test thoroughly with a real BMS
  5. Update documentation if needed
  6. Submit a pull request with a clear description

Code Style

  • Follow PEP 8 style guide
  • Use type hints where appropriate
  • Add docstrings to new functions/classes
  • Keep code consistent with existing style

Testing

Before submitting:

  • Test with actual hardware if possible
  • Verify no errors in Home Assistant logs
  • Check that entities update correctly
  • Ensure configuration flow works

Development Setup