1
0
mirror of https://github.com/esphome/esphome.git synced 2024-12-05 15:28:47 +01:00
esphome/CONTRIBUTING.md

19 lines
1.0 KiB
Markdown
Raw Normal View History

# Contributing to ESPHome
2018-10-12 11:26:05 +02:00
This python project is responsible for reading in YAML configuration files,
2018-10-12 11:26:05 +02:00
converting them to C++ code. This code is then converted to a platformio project and compiled
with [esphome-core](https://github.com/esphome/esphome-core), the C++ framework behind the project.
2018-10-12 11:26:05 +02:00
For a detailed guide, please see https://esphome.io/guides/contributing.html#contributing-to-esphomeyaml
2018-10-12 11:26:05 +02:00
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](https://github.com/esphome/esphome-docs). See [contributing to esphome-docs](https://esphome.io/guides/contributing.html#contributing-to-esphomedocs)
2018-10-12 11:26:05 +02:00
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.