From ecb429c9c99e3f96bb24d53dd895b90ba8fe003a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=9F=B3=E4=BD=9A?= Date: Mon, 27 Oct 2025 12:05:28 +0800 Subject: [PATCH] Update: add dingtakl pic, delete _guidelines --- CONTRIBUTING.md | 4 ++ CONTRIBUTING_GUIDELINES.md | 91 -------------------------------------- CONTRIBUTING_zh.md | 4 ++ README.md | 2 +- 4 files changed, 9 insertions(+), 92 deletions(-) delete mode 100644 CONTRIBUTING_GUIDELINES.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b0b84b3..8ecbf71 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,10 @@ Connect with us through: - **Discord**: Join our Discord channel for real-time discussions - **DingTalk**: Chinese users can join our DingTalk group +| [Discord](https://discord.gg/eYMpfnkG8h) | DingTalk | +|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| | | + ## Reporting Issues ### Bugs diff --git a/CONTRIBUTING_GUIDELINES.md b/CONTRIBUTING_GUIDELINES.md deleted file mode 100644 index 5b2670a..0000000 --- a/CONTRIBUTING_GUIDELINES.md +++ /dev/null @@ -1,91 +0,0 @@ -# ๐Ÿค Contributing Guide - -Welcome to contribute to the AgentScope Sample Agents project! Please follow this guide to ensure efficient collaboration. - - ---- - -# ๐Ÿ“ Directory Structure Requirements -All examples must be organized by functionality. The structure follows the root README.md layout: -```bash -agentscope-samples/ -โ”œโ”€โ”€ browser_use/ # Browser automation examples -โ”‚ โ”œโ”€โ”€ agent_browser/ # Pure Python browser agent -โ”‚ โ””โ”€โ”€ browser_use_fullstack_runtime/ # Full-stack runtime version -โ”œโ”€โ”€ deep_research/ # Deep research examples -โ”‚ โ”œโ”€โ”€ agent_deep_research/ -โ”‚ โ””โ”€โ”€ qwen_langgraph_search_fullstack_runtime/ -โ”œโ”€โ”€ games/ -โ”‚ โ””โ”€โ”€ game_werewolves/ # Werewolf game -โ”œโ”€โ”€ conversational_agents/ # Conversational applications -โ”‚ โ”œโ”€โ”€ chatbot/ -โ”‚ โ””โ”€โ”€ multiagent_conversation/ -โ”œโ”€โ”€ functionality/ # Functional examples -โ”‚ โ”œโ”€โ”€ long_term_memory_mem0/ -โ”‚ โ””โ”€โ”€ stream_printing_messages/ -โ””โ”€โ”€ CONTRIBUTING_GUIDELINES.md -``` - - ---- - -# ๐Ÿ“ฅ Submitting a Pull Request (PR) - -### 1. **Directory Placement** -- **Location**: - Choose an existing subdirectory (e.g., `browser_use/`ใ€`games/`), or create a new one (update the **Example List** table in the root `README.md`) -- **File Naming**: - - Example files: `feature_description.py`(ๅฆ‚ `chatbot_multi_turn.py`) - - Test files: `test_feature_description.py` - -### 2. **Write a Detailed README** -- **Subdirectory `README.md`**: - Include the following to ensure reproducibility: - ```markdown - ## Example Name (e.g., Multi-turn Chatbot) - - ### ๐Ÿ“Œ Description - Demonstrates the implementation of multi-turn conversations. - - ### ๐Ÿ“ฆ Dependencies - ```bash - pip install -r requirements.txt - ``` - -### ๐Ÿš€ Run Command -```bash -python chatbot_multi_turn.py -``` - - -- **Root `README.md`**: -Update the **Example List** table with links to new examples. - -### 3. **Dependency Management** -- **Each Subdirectory Requires `requirements.txt`**: -List only dependencies needed for that example: - -```txt -openai==0.27.0 -pandas==2.0.0 -``` - -### 4. **Code Formatting** -- **Install `pre-commit`**: -```bash -pip install pre-commit -pre-commit install -pre-commit run --all-files -# Fix any formatting errors (e.g., indentation, line length) -``` - - -### PR Checklist -- [ ] Example placed in the correct subdirectory (e.g., `browser_use/`ใ€`games/`) -- [ ] Subdirectory includes `README.md` and `requirements.txt` -- [ ] Code formatted with `pre-commit` -- [ ] New test cases cover core functionality -- [ ] Root `README.md` updated with the new example -- [ ] PR title is clear (e.g., `Add multi-turn chatbot example`) - ---- diff --git a/CONTRIBUTING_zh.md b/CONTRIBUTING_zh.md index 8c8d23b..9350879 100644 --- a/CONTRIBUTING_zh.md +++ b/CONTRIBUTING_zh.md @@ -10,6 +10,10 @@ - **Discord**๏ผšๅŠ ๅ…ฅๆˆ‘ไปฌ็š„ Discord ้ข‘้“่ฟ›่กŒๅฎžๆ—ถ่ฎจ่ฎบ - **้’‰้’‰**๏ผšไธญๅ›ฝ็”จๆˆทๅฏไปฅๅŠ ๅ…ฅๆˆ‘ไปฌ็š„้’‰้’‰็พค +| [Discord](https://discord.gg/eYMpfnkG8h) | DingTalk | +|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| +| | | + ## ๆŠฅๅ‘Š้—ฎ้ข˜ ### Bug diff --git a/README.md b/README.md index 13de567..01d23b7 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ We welcome contributions such as: - Documentation improvements - Code contributions -See the [Contributing Guidelines](https://github.com/agentscope-ai/agentscope-samples/blob/main/CONTRIBUTING_GUIDELINES.md) for details. +See the [Contributing](https://github.com/agentscope-ai/agentscope-samples/blob/main/CONTRIBUTING.md) for details. ------