From 3f1e48e597637642f17769796cb4bb6acb360f3a Mon Sep 17 00:00:00 2001 From: Marcin Domanski Date: Fri, 30 Nov 2018 10:11:14 +0100 Subject: [PATCH 1/2] Add note about naming events for components --- 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 d46f16b76b4..112d1c40743 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. For example for `xiaomi_aqara` component use `xiaomi_aqara.click` instead of `click`. From ff9d0d3e9d786d662c94194f8c5b8b3b36e9a3bb Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Sat, 1 Dec 2018 23:27:05 +0100 Subject: [PATCH 2/2] Minor changes --- docs/creating_component_code_review.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/creating_component_code_review.md b/docs/creating_component_code_review.md index 112d1c40743..57605e2cedf 100644 --- a/docs/creating_component_code_review.md +++ b/docs/creating_component_code_review.md @@ -51,4 +51,4 @@ status = bridge.status() 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. For example for `xiaomi_aqara` component use `xiaomi_aqara.click` instead of `click`. +Prefix component event names with component name itself. For example, use `xiaomi_aqara.click` instead of `click` for the `xiaomi_aqara` component.