esphome/CONTRIBUTING.md

1.0 KiB

Contributing to ESPHome

This python project is responsible for reading in YAML configuration files, converting them to C++ code. This code is then converted to a platformio project and compiled with esphome-core, the C++ framework behind the project.

For a detailed guide, please see https://esphome.io/guides/contributing.html#contributing-to-esphomeyaml

Things to note when contributing:

  • Please test your changes :)
  • If a new feature is added or an existing user-facing feature is changed, you should also update the docs. See contributing to esphome-docs for more information.
  • Please also update the tests in the tests/ folder. You can do so by just adding a line in one of the YAML files which checks if your new feature compiles correctly.
  • Sometimes I will let pull requests linger because I'm not 100% sure about them. Please feel free to ping me after some time.