diff --git a/_static/custom.css b/_static/custom.css index b442b6a9e..451d5cb4b 100644 --- a/_static/custom.css +++ b/_static/custom.css @@ -256,7 +256,7 @@ div.body p, div.body dd, div.body li, div.body blockquote { background: #212121; color: #ececec; } - + } body, div.body { @@ -281,7 +281,7 @@ div.body p, div.body dd, div.body li, div.body blockquote { color: #ececec; background-color: #212121; } - + a, a.reference, a:visited { color: #00bfff; border-bottom: 1px dotted #00bfff; @@ -326,7 +326,7 @@ div.body p, div.body dd, div.body li, div.body blockquote { color: #e2e2e2; } - div.note, div.tip { + div.note, div.tip, div.important { background-color: #2d2c2c; border: 1px solid #808080; } @@ -339,4 +339,4 @@ div.body p, div.body dd, div.body li, div.body blockquote { background-color: #8e8129; } -} \ No newline at end of file +} diff --git a/guides/contributing.rst b/guides/contributing.rst index 5dd9e0394..e1b37be32 100644 --- a/guides/contributing.rst +++ b/guides/contributing.rst @@ -695,6 +695,27 @@ Standard for the esphome-core codebase: docker run --rm -v "$($current_dir):/esphome" -it ghcr.io/esphome/esphome-lint script/quicklint +PRs are being drafted when changes are needed +--------------------------------------------- + +If there have been changes requested to your PR, our bot will automatically mark your PR as a draft. +This means that the PR is not ready to be merged or further reviewed for the moment. + +Draft PRs tell other reviewers that look at the list of all PRs that this PR is currently in progress and doesn't require their attention yet. + +Once you have made the requested changes, you can mark the PR as ready for review again by clicking the "Ready for review button": + +.. figure:: images/pr-draft-ready.png + :align: center + :width: 100.0% + :alt: The ready for review button in the bottom of a PR in draft mode + +Before you click the "Ready for review" button, ensure you have addressed all requested changes, +there are no merge conflicts, and that all our CI jobs and checks are passing successfully. + +Once you've clicked the "Ready for review" button, the PR will return to a normal state again, +and our bot will automatically notify the reviewers who requested the changes that the PR is ready to go! + See Also diff --git a/guides/images/pr-draft-ready.png b/guides/images/pr-draft-ready.png new file mode 100644 index 000000000..216ae2d88 Binary files /dev/null and b/guides/images/pr-draft-ready.png differ