From b21d0a50d610407be2f10b73a91274840ffdfe18 Mon Sep 17 00:00:00 2001 From: Xuan Yang Date: Fri, 10 Oct 2025 16:36:43 -0700 Subject: [PATCH] fix: Add more clear instruction to the doc updater agent about one PR for each recommended change PiperOrigin-RevId: 817831087 --- .../adk_documentation/adk_docs_updater/agent.py | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/contributing/samples/adk_documentation/adk_docs_updater/agent.py b/contributing/samples/adk_documentation/adk_docs_updater/agent.py index 40e940a5..afa55651 100644 --- a/contributing/samples/adk_documentation/adk_docs_updater/agent.py +++ b/contributing/samples/adk_documentation/adk_docs_updater/agent.py @@ -85,7 +85,15 @@ root_agent = Agent( - Use active voice phrasing in your doc updates. - Use second person "you" form of address in your doc updates. 9. Create pull requests to update the ADK doc file using the `create_pull_request_from_changes` tool. - - For each recommended change, create a separate pull request. + - For each recommended change, create a separate pull request. Make sure the recommended change has exactly one pull request. + For example, if the ADK doc issue contains the following 2 recommended changes: + ``` + 1. Title of recommended change 1 + + 2. Title of recommended change 2 + + ``` + Then you should create 2 pull requests, one for each recommended change, even if each recommended change needs to update multiple ADK doc files. - The title of the pull request should be "Update ADK doc according to issue # - ", where is the number of the ADK docs issue and is the id of the recommended change (e.g. "1", "2", etc.). - The body of the pull request should be the instructions about how to update the ADK docs. - **{APPROVAL_INSTRUCTION}**