-
Notifications
You must be signed in to change notification settings - Fork 0
chore: add repository guidelines and pin google-adk #57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Repository Guidelines | ||
|
|
||
| ## Project Structure & Module Organization | ||
| - `src/python/role_play/` contains backend domains: `chat/`, `server/`, `common/`, `evaluation/`, `voice/`, and `dev_agents/`. | ||
| - `src/python/run_server.py` is the local backend entrypoint. | ||
| - `src/ts/role_play/ui/` is the Vue 3 + TypeScript frontend (`components/`, `services/`, `types/`, `locales/`). | ||
| - `test/python/unit/` and `test/python/integration/` hold backend tests; shared fixtures live in `test/python/fixtures/`. | ||
| - `data/resources/` stores scenario/character/script JSON content; environment settings live in `config/{dev,beta,prod}.yaml`; project utilities are in `scripts/`. | ||
| - Keep backend models and frontend API types aligned (Pydantic models in Python should be reflected in `src/ts/role_play/ui/src/types/`). | ||
|
|
||
| ## Build, Test, and Development Commands | ||
| - `make dev-setup`: create/recreate `venv`, install Python dependencies, validate resources, and sync resource data. | ||
| - `source venv/bin/activate && JWT_SECRET_KEY=dev-secret python src/python/run_server.py`: run backend locally. | ||
| - `cd src/ts/role_play/ui && npm install && npm run dev`: run frontend (Vite dev server). | ||
| - `make test`: full Python suite with coverage (`--cov-fail-under=25`). | ||
| - `make test-unit` / `make test-integration`: targeted backend suites. | ||
| - `make validate-resources` and `make update-resource-metadata`: validate and maintain resource JSON metadata. | ||
| - `make run-local-docker DATA_DIR=./data_local`: build and run local Docker setup. | ||
|
|
||
| ## Coding Style & Naming Conventions | ||
| - Python: 4-space indentation, type hints on public interfaces, `snake_case` functions/modules, `PascalCase` classes. | ||
| - Backend handlers are stateless: avoid request state in instance/global variables; prefer dependency injection via FastAPI `Depends(...)`. | ||
| - Storage keys are extension-free and user-scoped (for example, `users/{user_id}/profile`, not `users/{user_id}.json`). | ||
| - Vue/TypeScript: `PascalCase` for component files (for example, `ChatWindow.vue`), `use*` prefix for composables, `*Api.ts` for API service modules. | ||
| - Run formatting/type checks before submitting backend changes: `black`, `isort`, and `mypy` (listed in `src/python/requirements-dev.txt`). | ||
|
|
||
| ## Testing Guidelines | ||
| - Pytest settings are defined in `pytest.ini` (`test_*.py`, `Test*`, `test_*` discovery patterns). | ||
| - Place isolated behavior tests in `test/python/unit/`; place cross-module/storage/auth flows in `test/python/integration/`. | ||
| - Follow naming patterns used across the tree: `test_<module>.py` files and descriptive `test_<behavior>_<condition>_<expected>()` functions. | ||
| - Use markers (`unit`, `integration`, `auth`, `storage`, `slow`) to narrow local runs during development. | ||
| - For backend PRs, run affected tests at minimum; use `make test` before merge for broad regressions. | ||
|
|
||
| ## Commit & Pull Request Guidelines | ||
| - Follow existing commit style: Conventional Commit-like subjects such as `fix(makefile): ...`, `feat(voice): ...`, or `fix: ...`. | ||
| - Keep commits focused; reference issue/PR IDs when applicable (for example, `(#53)`). | ||
| - PRs should include scope, behavior impact, and verification commands run; add screenshots for UI changes. | ||
| - Ensure relevant GitHub checks pass: Python Unit Tests on PRs, plus Make Dry Run when touching Makefile/build/deploy paths. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| google-adk | ||
| google-adk==1.25.0 | ||
| openai | ||
| pydantic[email] | ||
| langchain | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The content of this file provides valuable guidelines for repository development. However, the filename
AGENTS.mdmay not be the most descriptive choice and could cause confusion, especially given thedev_agents/directory mentioned within the document. A more conventional and discoverable name likeCONTRIBUTING.mdorDEVELOPMENT.mdwould better reflect its purpose and make it easier for contributors to find.