From c746abacbe474dda5df9a7a49cd69a4a5d059d1f Mon Sep 17 00:00:00 2001 From: Shifat Rahman Date: Sat, 12 Apr 2025 12:55:15 +1000 Subject: [PATCH 1/3] updated docs for windows command line disclaimer --- CONTRIBUTING.md | 7 +++++++ README.md | 13 +++++++++++++ 2 files changed, 20 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bc23aaed4be..c80a968960f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,6 +25,13 @@ This project follows ## Contribution process +### Code Style and Standards + +1. All Python files must be saved with UTF-8 encoding +2. Line endings should be LF (Unix-style), not CRLF +3. Avoid creating Python files using command-line tools (especially on Windows) +4. Use a proper text editor (VS Code, PyCharm, etc.) for file creation and editing + ### Code reviews All submissions, including submissions by project members, require review. We diff --git a/README.md b/README.md index 9ed221476ac..4090e6ee70b 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,21 @@ pip install google-adk ## 🏁 Getting Started +Create a new directory for your agent: + +```bash +# On Unix/Linux/macOS: +mkdir my_agent + +# On Windows: +# Create the directory using File Explorer or: +md my_agent +``` + Create your first agent (`my_agent/agent.py`): +> ⚠️ **Important Note for Windows Users**: Do not use `echo` or redirection (`>`) to create Python files as this can cause encoding issues. Instead, use a text editor like VS Code, PyCharm, or Notepad++ and ensure files are saved with UTF-8 encoding. + ```python # my_agent/agent.py from google.adk.agents import Agent From 2d871a75871ec55d6a6bc9c7703efcb2b58a1f3d Mon Sep 17 00:00:00 2001 From: Shifat Rahman <87413554+Shifat7@users.noreply.github.com> Date: Sat, 12 Apr 2025 18:34:26 +1000 Subject: [PATCH 2/3] Update README.md --- README.md | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/README.md b/README.md index 6f8ef5405e9..cb97a1a9b26 100644 --- a/README.md +++ b/README.md @@ -55,28 +55,9 @@ deploying agents: * **[Documentation](https://google.github.io/adk-docs)** -## 🏁 Getting Started - -Create a new directory for your agent: - -```bash -# On Unix/Linux/macOS: -mkdir my_agent - -# On Windows: -# Create the directory using File Explorer or: -md my_agent -``` - -Create your first agent (`my_agent/agent.py`): - -> ⚠️ **Important Note for Windows Users**: Do not use `echo` or redirection (`>`) to create Python files as this can cause encoding issues. Instead, use a text editor like VS Code, PyCharm, or Notepad++ and ensure files are saved with UTF-8 encoding. - - ## 🏁 Feature Highlight ### Define a single agent: - ```python from google.adk.agents import Agent from google.adk.tools import google_search From 08e03bd4ed7cc10cc46ac998d5b9dbd577de8af2 Mon Sep 17 00:00:00 2001 From: Shifat Rahman <87413554+Shifat7@users.noreply.github.com> Date: Sat, 12 Apr 2025 18:34:39 +1000 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c80a968960f..32ad34d6504 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,11 +30,10 @@ This project follows 1. All Python files must be saved with UTF-8 encoding 2. Line endings should be LF (Unix-style), not CRLF 3. Avoid creating Python files using command-line tools (especially on Windows) -4. Use a proper text editor (VS Code, PyCharm, etc.) for file creation and editing ### Code reviews All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more -information on using pull requests. \ No newline at end of file +information on using pull requests.