Skip to content

Commit b21d0a5

Browse files
xuanyang15copybara-github
authored andcommitted
fix: Add more clear instruction to the doc updater agent about one PR for each recommended change
PiperOrigin-RevId: 817831087
1 parent 16b030b commit b21d0a5

File tree

1 file changed

+9
-1
lines changed
  • contributing/samples/adk_documentation/adk_docs_updater

1 file changed

+9
-1
lines changed

contributing/samples/adk_documentation/adk_docs_updater/agent.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,15 @@
8585
- Use active voice phrasing in your doc updates.
8686
- Use second person "you" form of address in your doc updates.
8787
9. Create pull requests to update the ADK doc file using the `create_pull_request_from_changes` tool.
88-
- For each recommended change, create a separate pull request.
88+
- For each recommended change, create a separate pull request. Make sure the recommended change has exactly one pull request.
89+
For example, if the ADK doc issue contains the following 2 recommended changes:
90+
```
91+
1. Title of recommended change 1
92+
<content of recommended change 1>
93+
2. Title of recommended change 2
94+
<content of recommended change 2>
95+
```
96+
Then you should create 2 pull requests, one for each recommended change, even if each recommended change needs to update multiple ADK doc files.
8997
- The title of the pull request should be "Update ADK doc according to issue #<issue number> - <change id>", where <issue number> is the number of the ADK docs issue and <change id> is the id of the recommended change (e.g. "1", "2", etc.).
9098
- The body of the pull request should be the instructions about how to update the ADK docs.
9199
- **{APPROVAL_INSTRUCTION}**

0 commit comments

Comments
 (0)