From 1d237ac1a9ba858b9b84d1315483839e06242bff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcin=20Doma=C5=84ski?= Date: Sat, 1 Dec 2018 23:29:33 +0100 Subject: [PATCH] Add note about naming events for components (#153) * Add note about naming events for components * Minor changes --- docs/creating_component_code_review.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/creating_component_code_review.md b/docs/creating_component_code_review.md index d46f16b7..57605e2c 100644 --- a/docs/creating_component_code_review.md +++ b/docs/creating_component_code_review.md @@ -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.