mirror of https://github.com/encounter/adk-python.git synced 2026-07-09 18:19:28 -07:00

Files

T

History

Gabriel Bengo 3c63c2ad39 fix(docs): fix grammar and remove duplicate words in documentation and source

Merge https://github.com/google/adk-python/pull/4335

Fixed 'the the' typos and grammatical errors in README, docstrings, and sample agents.

**Please ensure you have read the [contribution guide](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) before creating a pull request.**

### Link to Issue or Description of Change

**1. Link to an existing issue (if applicable):**

- Closes: N/A
- Related: N/A

**2. Or, if no issue exists, describe the change:**

**Problem:**
While exploring the repository, I noticed a few minor writing errors that impact professional readability:
1.  **Grammar:** A subject-verb agreement error in `README.md` and `llms.txt` ("guide the agents works together").
2.  **Duplicate Words:** Several instances of stuttering typos (repeating "the the" or "but the the") in docstrings within `src/` and the `contributing/samples/` directories.

**Solution:**
I have applied the following fixes to improve documentation quality:
*   Corrected phrasing to "guide the agents to work together" in the README.
*   Removed redundant instances of "the" in `eval_metrics.py`, `spanner/settings.py`, and the sample agent docstrings.
*   **No functional code or logic was altered.**

### Testing Plan

**Unit Tests:**

- [x] All unit tests pass locally.

_Summary:_
Since this PR is strictly limited to documentation, comments, and docstrings, no new tests were required. I ran the standard test suite to ensure no syntax errors were accidentally introduced, and everything passed successfully.

**Manual End-to-End (E2E) Tests:**
N/A — This is a static documentation fix.

### Checklist

- [x] I have read the [CONTRIBUTING.md](https://github.com/google/adk-python/blob/main/CONTRIBUTING.md) document.
- [x] I have performed a self-review of my own code.
- [ ] I have commented my code, particularly in hard-to-understand areas. (N/A)
- [ ] I have added tests that prove my fix is effective or that my feature works. (N/A - Doc fix only)
- [x] New and existing unit tests pass locally with my changes.
- [ ] I have manually tested my changes end-to-end. (N/A)
- [x] Any dependent changes have been merged and published in downstream modules.

### Additional context

_None._

COPYBARA_INTEGRATE_REVIEW=https://github.com/google/adk-python/pull/4335 from 88448844:fix-typos-and-docs 200668dad0c216b81d7008d9d6625ac135c9006e
PiperOrigin-RevId: 865530036

2026-02-04 12:31:54 -08:00

__init__.py

chore: Upgrade to headers to 2026

2026-01-20 14:50:09 -08:00

agent.py

fix(docs): fix grammar and remove duplicate words in documentation and source

2026-02-04 12:31:54 -08:00

main.py

chore: Upgrade to headers to 2026

2026-01-20 14:50:09 -08:00

README.md

docs: Remove the duplicated label instructions for the ADK triaging agent

2025-12-03 16:55:35 -08:00

settings.py

chore: Upgrade to headers to 2026

2026-01-20 14:50:09 -08:00

utils.py

chore: Upgrade to headers to 2026

2026-01-20 14:50:09 -08:00

README.md

ADK Issue Triaging Assistant

The ADK Issue Triaging Assistant is a Python-based agent designed to help manage and triage GitHub issues for the google/adk-python repository. It uses a large language model to analyze issues, recommend appropriate component labels, set issue types, and assign owners based on predefined rules.

This agent can be operated in two distinct modes: an interactive mode for local use or as a fully automated GitHub Actions workflow.

Triaging Workflow

The agent performs different actions based on the issue state:

Condition	Actions
Issue without component label	Add component label + Set issue type (Bug/Feature)
Issue with "planned" label but no assignee	Assign owner based on component label
Issue with "planned" label AND no component label	Add component label + Set type + Assign owner

Component Labels

The agent can assign the following component labels, each mapped to an owner:

a2a, agent engine, auth, bq, core, documentation, eval, live, mcp, models, services, tools, tracing, web, workflow

Issue Types

Based on the issue content, the agent will set the issue type to:

Bug: For bug reports
Feature: For feature requests

Interactive Mode

This mode allows you to run the agent locally to review its recommendations in real-time before any changes are made to your repository's issues.

Features

Web Interface: The agent's interactive mode can be rendered in a web browser using the ADK's adk web command.
User Approval: In interactive mode, the agent is instructed to ask for your confirmation before applying labels or assigning owners.

Running in Interactive Mode

To run the agent in interactive mode, first set the required environment variables. Then, execute the following command in your terminal:

adk web

This will start a local server and provide a URL to access the agent's web interface in your browser.

GitHub Workflow Mode

For automated, hands-off issue triaging, the agent can be integrated directly into your repository's CI/CD pipeline using a GitHub Actions workflow.

Workflow Triggers

The GitHub workflow is configured to run on specific triggers:

New Issues (opened): When a new issue is created, the agent adds an appropriate component label and sets the issue type.
Planned Label Added (labeled with "planned"): When an issue is labeled as "planned", the agent assigns an owner based on the component label. If the issue doesn't have a component label yet, the agent will also add one.
Scheduled Runs: The workflow runs every 6 hours to process any issues that need triaging (either missing component labels or missing assignees for "planned" issues).

Automated Actions

When running as part of the GitHub workflow, the agent operates non-interactively:

Component Labeling: Automatically applies the most appropriate component label
Issue Type Setting: Sets the issue type to Bug or Feature based on content
Owner Assignment: Only assigns owners for issues marked as "planned"

This behavior is configured by setting the INTERACTIVE environment variable to 0 in the workflow file.

Workflow Configuration

The workflow is defined in a YAML file (.github/workflows/triage.yml). This file contains the steps to check out the code, set up the Python environment, install dependencies, and run the triaging script with the necessary environment variables and secrets.

Setup and Configuration

Whether running in interactive or workflow mode, the agent requires the following setup.

Dependencies

The agent requires the following Python libraries.

pip install --upgrade pip
pip install google-adk requests

Environment Variables

The following environment variables are required for the agent to connect to the necessary services.

GITHUB_TOKEN: (Required) A GitHub Personal Access Token with issues:write permissions. Needed for both interactive and workflow modes.
GOOGLE_API_KEY: (Required) Your API key for the Gemini API. Needed for both interactive and workflow modes.
OWNER: The GitHub organization or username that owns the repository (e.g., google). In the workflow, this is automatically set from the repository context.
REPO: The name of the GitHub repository (e.g., adk-python). In the workflow, this is automatically set from the repository context.
INTERACTIVE: Controls the agent's interaction mode. For the automated workflow, this is set to 0. For interactive mode, it should be set to 1 or left unset.

For local execution in interactive mode, you can place these variables in a .env file in the project's root directory. For the GitHub workflow, they should be configured as repository secrets.