jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-25 02:06:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add note about naming events for components (#153)

Browse Source 
* Add note about naming events for components

* Minor changes
This commit is contained in:
Marcin Domański 2018-12-01 23:29:33 +01:00 committed by Fabian Affolter
parent 99fb252b4a
commit 1d237ac1a9
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/creating_component_code_review.md
View File

@ -49,3 +49,6 @@ status = bridge.status()
### 5. Limit platforms included in initial pull request
Large pull requests mean there is a larger chance of finding problems that need to be addressed, and more code that needs to be reviewed between every requested change. If your new component will have multiple platforms, try and limit your initial pull request to a single platform. Once the initial component is merged, you can submit additional PRs for the remaining platforms. This allows reviewers to sign off on smaller chunks of code one at a time, and lets us get your new feature in sooner. Pull requests containing large code dumps will not be a priority for review.
### 6. Event names
Prefix component event names with component name itself. For example, use `xiaomi_aqara.click` instead of `click` for the `xiaomi_aqara` component.