Skip to content

Commit a1a1dbf

Browse files
committed
chore(skills): Unify skill names and improve guidelines for ADK development
- Rename setup-dev-env to adk-setup and git-ops to adk-git for consistency. - Update adk-setup skill to use parallel tests and remove internal tool references. - Update adk-git skill to include pre-commit checks and guidelines for detailed commit messages. Change-Id: I4609bf035c84914f3e9e271d5139193d53ea0806
1 parent 243720f commit a1a1dbf

2 files changed

Lines changed: 41 additions & 17 deletions

File tree

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: git-ops
2+
name: adk-git
33
description: Use for any git operation (commit, push, pull, rebase, branch, PR, cherry-pick, etc.). Provides commit message format and conventions.
44
---
55

@@ -43,18 +43,36 @@ A reviewer reading only the subject should understand the motivation.
4343
- Good: `Prevent duplicate events when resuming HITL`
4444
- Bad: `Check interrupt_id before appending`
4545

46-
Self-check before committing: read your subject line and ask
47-
"does this tell me *why* someone made this change?" If it only
48-
describes *what* changed, rewrite it.
46+
### Detailed Commit Messages
47+
48+
Promote detailed commit messages by including a short, concrete explanation in the body:
49+
- For **features**: Give a sample usage or explain the new capability.
50+
- For **fixes**: Explain what caused the error and how the fix addresses it.
51+
52+
**Example (Feature):**
53+
```
54+
feat(workflow): Support JSON string parsing in schema validation
55+
56+
Automatically parse JSON strings into dicts or Pydantic models when input_schema or output_schema is defined on a node.
57+
```
58+
59+
**Example (Fix):**
60+
```
61+
fix(sessions): Prevent duplicate events when resuming HITL
62+
63+
The interrupt_id was not checked before appending, causing duplicates if the user resumed multiple times. Added a check to ignore already processed interrupts.
64+
```
65+
66+
Self-check before committing: read your subject line and ask "does this tell me _why_ someone made this change?" If it only describes _what_ changed, rewrite it.
4967

5068
### Rules
5169

5270
1. **Imperative mood** - "Add feature" not "Added feature".
5371
2. **Capitalize** first letter of description (for release-please changelog).
5472
3. **No period** at end of subject line.
5573
4. **50 char limit** on subject line when possible, max 72.
56-
5. **Use body for context** - Add a blank line then explain *why*,
57-
not *how*, when the subject alone isn't enough.
74+
5. **Use body for context** - Add a blank line then explain _why_,
75+
not _how_, when the subject alone isn't enough.
5876

5977
### Examples
6078

@@ -64,3 +82,8 @@ fix(sessions): Prevent memory leak on concurrent session cleanup
6482
refactor(tools): Unify env var checks across tool implementations
6583
docs: Add contributing guide for first-time contributors
6684
```
85+
86+
## Pre-commit Hooks
87+
88+
> [!IMPORTANT]
89+
> Before performing any commit, check if `pre-commit` is installed and configured with the expected hooks (`isort`, `pyink`, `addlicense`, `mdformat`). If not, remind the user to set up pre-commit hooks using the `adk-setup` skill.
Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
name: setup-dev-env
2+
name: adk-setup
33
description: Set up a local development environment for the ADK Python project. Use when the user wants to get started developing, set up their environment, install dependencies, or prepare for contributing.
44
disable-model-invocation: true
55
---
@@ -30,45 +30,46 @@ Check the following before proceeding:
3030
Run these commands from the project root:
3131

3232
3. **Create and activate a virtual environment:**
33+
3334
```bash
3435
uv venv --python "python3.11" ".venv"
3536
source .venv/bin/activate
3637
```
3738

3839
4. **Install all dependencies for development:**
40+
3941
```bash
4042
uv sync --all-extras
4143
```
4244

4345
5. **Install development tools:**
46+
4447
```bash
4548
uv tool install pre-commit
4649
uv tool install tox --with tox-uv
4750
```
4851

4952
6. **Install addlicense (requires Go):**
53+
5054
```bash
5155
go version && go install github.com/google/addlicense@latest
5256
```
53-
If Go is not installed, tell the user:
54-
"Go is required for the addlicense tool. Please install Go from
55-
https://go.dev/dl/ and then re-run `/setup-dev-env` to complete
56-
the setup."
57+
58+
> [!NOTE]
59+
> If Go is not installed, tell the user:
60+
> "Go is required for the addlicense tool. Please install Go from https://go.dev/dl/ and then re-run the `adk-setup` skill to complete the setup."
5761
5862
7. **Set up pre-commit hooks:**
63+
5964
```bash
6065
pre-commit install
6166
```
6267

63-
8. **Verify everything works by running tests locally (Fast):**
68+
8. **Verify everything works by running tests locally:**
6469
```bash
65-
pytest tests/unittests -x -q --no-header 2>&1 | tail -5
70+
pytest tests/unittests -n auto
6671
```
6772

68-
## Troubleshooting
69-
70-
- If `uv run` fails with `401 Unauthorized` against `us-python.pkg.dev/artifact-foundry-prod/...`, run `gpkg setup` to fix credentials before retrying.
71-
7273
## Key Commands Reference
7374

7475
| Task | Command |

0 commit comments

Comments
 (0)