Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 1.25 KB

Contributing to ntopng-ha-bridge

Thank you for your interest in contributing to ntopng-ha-bridge!

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Create a feature branch

Development Setup

For HACS Component Development

# Install development dependencies
pip install ruff pytest

# Run linting
ruff check custom_components/
ruff check ntopng-ha-bridge.py

# Copy to Home Assistant for testing
cp -r custom_components/ntopng ~/.homeassistant/custom_components/

For Docker Bridge Development

# Create environment
cp .env.example .env
# Edit .env with your ntopng details

# Run locally
python3 ntopng-ha-bridge.py

# Or with Docker
docker compose up

Code Style

  • Follow PEP 8 guidelines
  • Use type hints where possible
  • Run ruff check before committing
  • Keep functions focused and well-documented

Pull Request Process

  1. Update the README.md if needed
  2. Update CHANGELOG.md with your changes
  3. Ensure all CI checks pass
  4. Request review from maintainers

Reporting Issues

When reporting issues, please include:

  • ntopng version
  • Home Assistant version
  • Deployment method (HACS or Docker)
  • Relevant log output
  • Steps to reproduce

Questions?

Open an issue or discussion on GitHub.