Skip to content

Commit 3717e04

Browse files
committed
cleanup README
1 parent 9cf35c3 commit 3717e04

2 files changed

Lines changed: 46 additions & 37 deletions

File tree

CONTRIBUTING.md

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,47 @@
1-
# How to contribute
1+
# Contributing to ADK TypeScript
22

3-
We'd love to accept your patches and contributions to this project.
3+
Thanks for your interest in contributing! This is an unofficial community port, and contributions are what make it better.
44

5-
## Before you begin
5+
## How to Contribute
66

7-
### Sign our Contributor License Agreement
7+
### Reporting Issues
88

9-
Contributions to this project must be accompanied by a
10-
[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
11-
You (or your employer) retain the copyright to your contribution; this simply
12-
gives us permission to use and redistribute your contributions as part of the
13-
project.
9+
- Check existing issues before creating a new one
10+
- Include version info, code snippets, and error messages
11+
- Describe expected vs actual behavior
1412

15-
If you or your current employer have already signed the Google CLA (even if it
16-
was for a different project), you probably don't need to do it again.
13+
### Pull Requests
1714

18-
Visit <https://cla.developers.google.com/> to see your current agreements or to
19-
sign a new one.
15+
1. Fork the repo and create a branch from `main`
16+
2. Make your changes with clear commit messages
17+
3. Add tests if applicable
18+
4. Ensure tests pass: `npm test`
19+
5. Submit a PR with a clear description
2020

21-
### Review our community guidelines
21+
### Development Setup
2222

23-
This project follows
24-
[Google's Open Source Community Guidelines](https://opensource.google/conduct/).
23+
```bash
24+
git clone https://github.com/njraladdin/adk-typescript.git
25+
cd adk-typescript
26+
npm install
27+
npm test
28+
```
2529

26-
## Contribution process
30+
### Code Style
2731

28-
### Code reviews
32+
- Follow existing TypeScript conventions
33+
- Use meaningful variable names
34+
- Add JSDoc comments for public APIs
35+
- Keep changes focused and atomic
2936

30-
All submissions, including submissions by project members, require review. We
31-
use GitHub pull requests for this purpose. Consult
32-
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
33-
information on using pull requests.
37+
### Areas We Need Help
38+
39+
- Bug fixes and stability improvements
40+
- Documentation improvements
41+
- Test coverage
42+
- Feature parity with Python ADK
43+
- Performance optimizations
44+
45+
## Code of Conduct
46+
47+
Be respectful and constructive. This is a learning community building cool AI stuff together.

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,33 +18,28 @@
1818
</h3>
1919
</html>
2020

21-
**⚠️ Unofficial Port & Experimental Status:** This is an unofficial TypeScript port of the [Google ADK Python library](https://github.com/google/adk-python). It's currently in an experimental (alpha) stage, so some features and APIs may be unstable or contain bugs.
21+
**⚠️ Unofficial Port & Experimental Status:** This is an unofficial TypeScript port of the [Google ADK Python library](https://github.com/google/adk-python). Currently in alpha - APIs may change.
2222

23-
**Agent Development Kit (ADK)** for TypeScript is a flexible and modular framework for developing and deploying AI agents. While optimized for Gemini and the Google ecosystem, ADK is model-agnostic, deployment-agnostic, and is built for compatibility with other frameworks. ADK was designed to make agent development feel more like software development, to make it easier for developers to create, deploy, and orchestrate agentic architectures that range from simple tasks to complex workflows.
23+
**ADK TypeScript** is a code-first framework for building and deploying AI agents. Optimized for Gemini but model-agnostic. Build agents like software: modular, testable, and production-ready.
2424

2525

2626
---
2727

2828
## ✨ Key Features
2929

30-
- **Rich Tool Ecosystem**: Utilize pre-built tools, custom functions,
31-
OpenAPI specs, or integrate existing tools to give agents diverse
32-
capabilities, all for tight integration with the Google ecosystem.
30+
- **Code-First Development**: Define agents, tools, and orchestration in TypeScript. Full control, testability, and version management.
3331

34-
- **Code-First Development**: Define agent logic, tools, and orchestration
35-
directly in TypeScript for ultimate flexibility, testability, and versioning.
32+
- **Rich Tool Ecosystem**: Pre-built tools, custom functions, OpenAPI specs. Tight Google ecosystem integration.
3633

37-
- **Modular Multi-Agent Systems**: Design scalable applications by composing
38-
multiple specialized agents into flexible hierarchies.
34+
- **Multi-Agent Systems**: Compose specialized agents into scalable hierarchies.
3935

40-
- **Deploy Anywhere**: Easily containerize and deploy agents on Cloud Run or
41-
scale with other cloud platforms.
36+
- **Deploy Anywhere**: Cloud Run, Docker, or any platform. Your choice.
4237

43-
- **Integrated Developer Tooling**: Develop and iterate locally with ease using the included CLI (`npx adk`) and Developer UI (`npx adk web`) for running agents, inspecting execution (`Event` stream), debugging, and visualizing agent graphs (`npx adk graph`).
38+
- **Developer Tooling**: CLI (`npx adk`), Web UI (`npx adk web`), graph visualization, and execution inspection.
4439

45-
- **Native Streaming Support**: Build real-time, interactive experiences with native support for bidirectional streaming (text, potentially audio/video) using `Runner.runLive` and `LiveRequestQueue`.
40+
- **Native Streaming**: Bidirectional streaming support via `Runner.runLive` and `LiveRequestQueue`.
4641

47-
- **Built-in Agent Evaluation**: Assess agent performance systematically with the `evaluation` module (`AgentEvaluator`). Create multi-turn evaluation datasets (`.test.json` files) and run evaluations locally via the CLI (`npx adk eval`).
42+
- **Built-in Evaluation**: Test agents with `.test.json` datasets via `npx adk eval`.
4843

4944
## 🚀 Installation
5045

@@ -218,7 +213,7 @@ npx adk deploy cloud_run <path_to_agent_folder> --project <your-gcp-project> --r
218213

219214
## 🤝 Contributing
220215

221-
We welcome contributions from the community! As this is a work-in-progress port, contributions are especially valuable. Whether it's bug reports, feature requests, documentation improvements, or code contributions, please see our [**Contributing Guidelines**](./CONTRIBUTING.md) (Link may need updating for TypeScript specifics) to get started.
216+
Contributions welcome! This is a community-driven port. Bug reports, features, docs, and code all appreciated. See [**Contributing Guidelines**](./CONTRIBUTING.md).
222217

223218
## 📄 License
224219

0 commit comments

Comments
 (0)