@@ -85,14 +85,30 @@ here are some tips:
8585 time commenting on/correcting your PR because you didn't name variables correctly or didn't prefix member variable
8686 accesses with ` this-> ` , it wastes time we could be using to review other PRs which * do* follow the standards.
8787- If you wish to take on a big project, such as refactoring a substantial section of the codebase or integrating
88- another open source project with ESPHome, please discuss this with us on [ Discord] ( https://discord.gg/KhAMKrd ) or
88+ another open source project with ESPHome, please discuss this with us on [ Discord] ( https://esphome.io/chat ) or
8989 [ create a discussion on GitHub] ( https://github.com/esphome/esphome/discussions ) ** before** you do all the work and
9090 attempt to submit a massive PR.
9191- If you are not sure about how you should proceed with some changes, ** please**
92- [ discuss it with us on Discord] ( https://discord.gg/KhAMKrd ) ** before** you go do a bunch of work that we can't (for
92+ [ discuss it with us on Discord] ( https://esphome.io/chat ) ** before** you go do a bunch of work that we can't (for
9393 whatever reason) accept...and then you have to go back and re-do it all to get your PR merged. It's easier to make
9494 corrections early-on -- and we want to help you!
9595
96+ #### How to approach large submissions
97+
98+ If you have a (very) large amount of code (thousands of lines) you want to submit:
99+
100+ - [ Discuss it with us on Discord] ( https://esphome.io/chat ) ** before** you begin the work.
101+ - ** Carefully plan a way to break the work into a series of smaller changes** which can be submitted independently of
102+ each other. For example, consider a piece of sensor hardware which provides measurements of seven different
103+ environmental parameters and can be connected via either I2C or SPI; the work might be broken into separate PRs for:
104+ - Implementing the base "hub" component
105+ - Extending the base for both I2C and SPI connectivity
106+ - Adding the various sensor platforms to make available the data the sensor reports
107+ - It's reasonable to submit all the PRs at once, but, if you do so, be sure to:
108+ - Link them together in the PR descriptions so that reviewers can follow the work.
109+ - Indicate the order in which the PRs should be reviewed and/or merged, if relevant.
110+ - Minimize (the potential for) conflicts as much as reasonably possible.
111+
96112## Can I Help Review PRs?
97113
98114** YES! PLEASE!!!**
0 commit comments