mirror of https://github.com/google/adk-docs.git synced 2026-09-14 16:16:59 +08:00

Files

T

Holt Skinner af2ee80fde docs: Fix formatting/spelling errors in Docs (#676 )

* docs: Update formatting of logging information

- Remove duplicates

* Fix formatting/spelling issues in Express Mode page

* Fix code formatting

* Rename "Google Cloud's" -> Google Cloud per branding guidelines

* Spelling fix on A2A

* Formatting fixes in a2a consuming

* Fix typo/formatting error on API Reference homepage

* Remove custom anchors in CONTRIBUTING.md because GFM doesn't support them

* Add imports to A2A Samples and update agent.json to agent-card.json

---------

Co-authored-by: Joe Fernandez <joefernandez@users.noreply.github.com>

2025-09-10 08:18:12 -07:00

2.6 KiB

Raw Permalink Blame History

How to contribute

Thank you for your interest in contributing! We appreciate your willingness to share your patches and improvements with the project.

Getting Started

Before you contribute, please take a moment to review the following:

1. Sign our Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.

If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.

Visit https://cla.developers.google.com/ to see your current agreements or to sign a new one.

2. Review Community Guidelines

We adhere to Google's Open Source Community Guidelines. Please familiarize yourself with these guidelines to ensure a positive and collaborative environment for everyone.

Contribution Workflow

Finding Something to Work On

Check the GitHub Issues for bug reports or feature requests. Feel free to pick up an existing issue or open a new one if you have an idea or find a bug.

Development Setup

Clone the repository:

git clone git@github.com:google/adk-docs.git
cd adk-docs

Create and activate a virtual environment:

python -m venv venv
source venv/bin/activate

Install dependencies:
```
pip install -r requirements.txt
```
Run the local development server:
```
mkdocs serve
```
This command starts a local server, typically at http://127.0.0.1:8000/.

The site will automatically reload when you save changes to the documentation files. For more details on the site configuration, see the mkdocs.yml file.

Code Reviews

All contributions, including those from project members, undergo a review process.

Create a Pull Request: We use GitHub Pull Requests (PRs) for code review. Please refer to GitHub Help if you're unfamiliar with PRs.
Review Process: Project maintainers will review your PR, providing feedback or requesting changes if necessary.
Merging: Once the PR is approved and passes any required checks, it will be merged into the main branch.

Consult GitHub Help for more information on using pull requests. We look forward to your contributions!

2.6 KiB Raw Permalink Blame History