jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-14 12:56:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update code_review_component.markdown

Browse Source
This commit is contained in:
Paulus Schoutsen 2017-07-28 23:43:45 -07:00 committed by GitHub
parent cf9c7cc55b
commit 7e226b0095
1 changed files with 6 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
source/developers/code_review_component.markdown
View File

@ -11,29 +11,23 @@ footer: true
A checklist of things to do when you're adding a new component. A checklist of things to do when you're adding a new component.
<p class='note'>
Not all existing platforms follow the requirements in this checklist. This cannot be used as a reason to not follow them!
</p>
### {% linkable_title Requirements %} ### {% linkable_title Requirements %}
1. Requirement version pinned: `REQUIREMENTS = ['phue==0.8.1']` 1. Requirement version pinned: `REQUIREMENTS = ['phue==0.8.1']`
2. If requirement hosted on GitHub: 2. We no longer want requirements hosted on GitHub. Please upload to PyPi.
- Point at a zip archive of a release tag or commit SHA.
- Add version found in zip-archive as hash to URL.
```python
REQUIREMENTS = [
'http://github.com/technicalpickles/python-nest'
'/archive/e6c9d56a8df455d4d7746389811f2c1387e8cb33.zip'
'#python-nest==3.0.3']
```
### {% linkable_title Configuration %} ### {% linkable_title Configuration %}
1. Voluptuous schema present for config validation 1. Voluptuous schema present for config validation
2. Default parameters specified in voluptuous schema, not in `setup_platform(…)` 2. Default parameters specified in voluptuous schema, not in `setup(…)`
3. Schema using as many generic config keys as possible from `homeassistant.const` 3. Schema using as many generic config keys as possible from `homeassistant.const`
4. If having platforms, have a `PLATFORM_SCHEMA`, otherwise `CONFIG_SCHEMA`. 4. If having platforms, have a `PLATFORM_SCHEMA`, otherwise `CONFIG_SCHEMA`.
5. If `PLATFORM_SCHEMA`, import base from `homeassistant.helpers.config_validation` 5. If `PLATFORM_SCHEMA`, import base from `homeassistant.helpers.config_validation`
### {% linkable_title Component/platform communication %} ### {% linkable_title Component/platform communication %}
1. If you need to share global data with platforms, use the dictionary `hass.data`. `hass.data[DATA_XY]` while `XY` is the component is preferred over `hass.data[DOMAIN]`. 1. If you need to share global data with platforms, use the dictionary `hass.data`. `hass.data[DATA_XY]` while `XY` is the component is preferred over `hass.data[DOMAIN]`.