Update: add dingtakl pic, delete _guidelines

This commit is contained in:
柳佚
2025-10-27 12:05:28 +08:00
parent e833c71e7b
commit ecb429c9c9
4 changed files with 9 additions and 92 deletions

View File

@@ -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 |
|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| <img src="https://gw.alicdn.com/imgextra/i1/O1CN01hhD1mu1Dd3BWVUvxN_!!6000000000238-2-tps-400-400.png" width="100" height="100"> | <img src="https://img.alicdn.com/imgextra/i1/O1CN01LxzZha1thpIN2cc2E_!!6000000005934-2-tps-497-477.png" width="100" height="100"> |
## Reporting Issues
### Bugs

View File

@@ -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`)
---

View File

@@ -10,6 +10,10 @@
- **Discord**:加入我们的 Discord 频道进行实时讨论
- **钉钉**:中国用户可以加入我们的钉钉群
| [Discord](https://discord.gg/eYMpfnkG8h) | DingTalk |
|----------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| <img src="https://gw.alicdn.com/imgextra/i1/O1CN01hhD1mu1Dd3BWVUvxN_!!6000000000238-2-tps-400-400.png" width="100" height="100"> | <img src="https://img.alicdn.com/imgextra/i1/O1CN01LxzZha1thpIN2cc2E_!!6000000005934-2-tps-497-477.png" width="100" height="100"> |
## 报告问题
### Bug

View File

@@ -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.
------