Skip to content

Latest commit

 

History

History
29 lines (18 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

29 lines (18 loc) · 1.19 KB
Raw

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, or any other method with the owners of this repository before making a change.

Our vision for this application

This simple app was built to simply synchronize the color of RGB lights with the thumbnail of a media player linked to Home Assistant, without needing much configuration.

The app shall remain simple with that focused task in mind.

Local development

  1. Clone this repository.
  2. Run pip3 install -r requirements.txt.
  3. Edit code, add tests and run pytest.

Testing on a Home Assistant instance

  1. Copy the media_lights_sync folder into appdaemon/apps/ on your Home Assistant instance.
  2. Update appdaemon/apps/apps.yaml with the proper configuration for your setup (see info.md).

Pull Request Process

  1. Ensure that the proposed changes do not break the current functionalities ot the app.
  2. Update the README.md with details of changes to the configuration or setup.
  3. If breaking changes are needed, make sure to specify exactly what needs to change.

For new version, the versioning scheme we use is SemVer.