From 370f4e9569f622b9daee47f9a5a2236be7ea3f9e Mon Sep 17 00:00:00 2001 From: Katie McLaughlin Date: Sun, 25 Oct 2026 14:10:53 +1300 Subject: [PATCH 1/3] docs: add dynamic links to PRs for review docs Uses config variables for customised links for any repo that embeds this shared content --- .../en/_shared/contribute/how/review-pr.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md index 31fa6bdb..567bd621 100644 --- a/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md @@ -14,6 +14,20 @@ It is entirely possible to THINK, while also providing an effective review. The It's important to remember to provide positive feedback in addition to identifying the areas needing improvement. If, for example, the changes are especially helpful, do something particularly clever, or you are introduced to an API that you didn't know about, let the author know! Never underestimate the effect of pointing out something someone has done correctly or well, in the middle of a situation where everything else you've pointed out are issues that need to be resolved. +### What is ready for review + +The simplest way to find open pull requests is to go to the project's pull requests page: https://github.com/beeware/{{project_name}}/pulls + +You can use the GitHub Search functionality to find any open pull requests for a project. + +For example: + +* [All open PRs, with passing tests for {{formal_name}}](https://github.com/search?q=org%3Abeeware+repo%3A{{project_name}}+is%3Apr+state%3Aopen+status%3Asuccess+draft%3Afalse+review%3Arequired&type=pullrequests&s=created&o=asc) +* [All open PRs, with passing tests for all projects](https://github.com/search?q=org%3Abeeware+is%3Apr+state%3Aopen+status%3Asuccess+draft%3Afalse+review%3Arequired&type=pullrequests&s=created&o=asc) +* [All open PRs across BeeWare](https://github.com/search?o=asc&q=org%3Abeeware+is%3Apr+is%3Aopen+draft%3Afalse+-author%3A%40me+archived%3Afalse&s=created&type=pullrequests) + +Note: Not all BeeWare repos have CI tests, and not all open PRs were created when PRs had tests. + ### GitHub review suggestions The GitHub review interface has a mechanism for change suggestions, in which you can provide the exact change you are suggesting as a replacement for the existing content. Keep in mind that, until they are accepted and committed, these suggested changes won't be run through pre-commit and the linting checks. Therefore, this feature should be used for smaller changes, as the larger the suggested change is, the more likely it is to introduce issues. From 36934738cd54c33b66f7e29a8570cbd5ffa7334e Mon Sep 17 00:00:00 2001 From: Katie McLaughlin Date: Sun, 1 Nov 2026 13:31:36 +1300 Subject: [PATCH 2/3] how -> what --- .../en/_shared/contribute/how/review-pr.md | 14 -------------- .../en/_shared/contribute/what/review-pr.md | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md index 567bd621..31fa6bdb 100644 --- a/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/how/review-pr.md @@ -14,20 +14,6 @@ It is entirely possible to THINK, while also providing an effective review. The It's important to remember to provide positive feedback in addition to identifying the areas needing improvement. If, for example, the changes are especially helpful, do something particularly clever, or you are introduced to an API that you didn't know about, let the author know! Never underestimate the effect of pointing out something someone has done correctly or well, in the middle of a situation where everything else you've pointed out are issues that need to be resolved. -### What is ready for review - -The simplest way to find open pull requests is to go to the project's pull requests page: https://github.com/beeware/{{project_name}}/pulls - -You can use the GitHub Search functionality to find any open pull requests for a project. - -For example: - -* [All open PRs, with passing tests for {{formal_name}}](https://github.com/search?q=org%3Abeeware+repo%3A{{project_name}}+is%3Apr+state%3Aopen+status%3Asuccess+draft%3Afalse+review%3Arequired&type=pullrequests&s=created&o=asc) -* [All open PRs, with passing tests for all projects](https://github.com/search?q=org%3Abeeware+is%3Apr+state%3Aopen+status%3Asuccess+draft%3Afalse+review%3Arequired&type=pullrequests&s=created&o=asc) -* [All open PRs across BeeWare](https://github.com/search?o=asc&q=org%3Abeeware+is%3Apr+is%3Aopen+draft%3Afalse+-author%3A%40me+archived%3Afalse&s=created&type=pullrequests) - -Note: Not all BeeWare repos have CI tests, and not all open PRs were created when PRs had tests. - ### GitHub review suggestions The GitHub review interface has a mechanism for change suggestions, in which you can provide the exact change you are suggesting as a replacement for the existing content. Keep in mind that, until they are accepted and committed, these suggested changes won't be run through pre-commit and the linting checks. Therefore, this feature should be used for smaller changes, as the larger the suggested change is, the more likely it is to introduce issues. diff --git a/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md index fe826a80..ca19a3e6 100644 --- a/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md @@ -12,6 +12,21 @@ Yes! You can offer a review on any pull request you see open on {{ formal_name } As a first-time contributor, you should feel free to review any pull request you find, even if it was submitted by a core team member. If you're a novice, you might be missing some larger project context; but we aim to keep the codebase approachable regardless of your level of experience. If there's something in the code that doesn't make sense, that might indicate there's a need for more documentation (either in the code, or as standalone design documentation). + +### What is ready for review + +The simplest way to find open pull requests is to go to the project's pull requests page: https://github.com/beeware/{{project_name}}/pulls + +You can use the GitHub Search functionality to find any open pull requests for a project. + +For example: + +* [All open PRs, with passing tests for {{formal_name}}](https://github.com/search?q=org%3Abeeware+repo%3A{{project_name}}+is%3Apr+state%3Aopen+status%3Asuccess+draft%3Afalse+review%3Arequired&type=pullrequests&s=created&o=asc) +* [All open PRs, with passing tests for all projects](https://github.com/search?q=org%3Abeeware+is%3Apr+state%3Aopen+status%3Asuccess+draft%3Afalse+review%3Arequired&type=pullrequests&s=created&o=asc) +* [All open PRs across BeeWare](https://github.com/search?o=asc&q=org%3Abeeware+is%3Apr+is%3Aopen+draft%3Afalse+-author%3A%40me+archived%3Afalse&s=created&type=pullrequests) + +Note: Not all BeeWare repos have CI tests, and not all open PRs were created when PRs had tests. + ## Contributing a pull request review /// details-abstract | Providing a pull request review From 4cbbcb91648bbbf47567f989830c89a31613f9c6 Mon Sep 17 00:00:00 2001 From: Katie McLaughlin Date: Sun, 1 Nov 2026 13:35:01 +1300 Subject: [PATCH 3/3] use new shortlink --- .../shared_content/en/_shared/contribute/what/review-pr.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md index ca19a3e6..5b5d2d0e 100644 --- a/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md +++ b/src/beeware_docs_tools/shared_content/en/_shared/contribute/what/review-pr.md @@ -12,7 +12,6 @@ Yes! You can offer a review on any pull request you see open on {{ formal_name } As a first-time contributor, you should feel free to review any pull request you find, even if it was submitted by a core team member. If you're a novice, you might be missing some larger project context; but we aim to keep the codebase approachable regardless of your level of experience. If there's something in the code that doesn't make sense, that might indicate there's a need for more documentation (either in the code, or as standalone design documentation). - ### What is ready for review The simplest way to find open pull requests is to go to the project's pull requests page: https://github.com/beeware/{{project_name}}/pulls @@ -23,7 +22,7 @@ For example: * [All open PRs, with passing tests for {{formal_name}}](https://github.com/search?q=org%3Abeeware+repo%3A{{project_name}}+is%3Apr+state%3Aopen+status%3Asuccess+draft%3Afalse+review%3Arequired&type=pullrequests&s=created&o=asc) * [All open PRs, with passing tests for all projects](https://github.com/search?q=org%3Abeeware+is%3Apr+state%3Aopen+status%3Asuccess+draft%3Afalse+review%3Arequired&type=pullrequests&s=created&o=asc) -* [All open PRs across BeeWare](https://github.com/search?o=asc&q=org%3Abeeware+is%3Apr+is%3Aopen+draft%3Afalse+-author%3A%40me+archived%3Afalse&s=created&type=pullrequests) +* [All open PRs across BeeWare](https://beeware.org/b/review) Note: Not all BeeWare repos have CI tests, and not all open PRs were created when PRs had tests.