From 90c56955a301767390cf8d28cfd032961b8898e2 Mon Sep 17 00:00:00 2001 From: Adam Mills Date: Fri, 9 Nov 2018 04:33:14 -0500 Subject: [PATCH] Document our preference for smaller component PRs (#145) --- 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 5a173d7a..d46f16b7 100644 --- a/docs/creating_component_code_review.md +++ b/docs/creating_component_code_review.md @@ -46,3 +46,6 @@ from phue import Bridge bridge = Bridge(...) 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.