Upstream/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2024-06-25 10:25:04 +02:00
Code Issues Projects Releases Wiki Activity
1d6b4bfcef
esphome/CONTRIBUTING.md
Otto Winter 3d9301a0f7
Rename esphomeyaml to esphome (#426) 
* Rename

* Update

* Add migration

* Fix

* Fix dashboard

* Change test

* Fixes

* Code cleanup

* Fix import order

* Update

* Automate docker builds

* Shellcheck
2019-02-13 16:54:02 +01:00

1.0 KiB
Raw Blame History

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.