diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a3c6a2..87268e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,6 +46,24 @@ If you'd like a feature or new type of example that doesn't exist in AgentScope ### Creating New Examples +#### Choose a Relevant Scenario + +We encourage examples across various domains including (but not limited to): + +| Domain | Example Ideas | +|--------|---------------| +| **Finance** | Robo-advisors, risk assessment, financial report analysis | +| **Healthcare** | Symptom checker, medical record summarization, medication reminders | +| **Education** | Personalized tutoring, auto-grading, Q&A knowledge retrieval | +| **E-commerce / Retail** | Customer service, product recommendation, inventory management | +| **Gaming / Entertainment** | NPC dialogue systems, dynamic story generators | +| **Office Automation** | Meeting summarizers, auto-reply email agents, scheduling coordinators | +| **Research** | Literature review assistants, data analysis agents | +| **SRE / DevOps** | Alert triage, log anomaly detection, root cause analysis, automated remediation | +| **General Utilities** | Multi-agent workflows, tool calling, memory management patterns | + +**Tip**: Pick a domain you know well or are passionate about—realistic use cases have the greatest impact! + #### Directory Structure Choose an appropriate category (`browser_use/`, `conversational_agents/`, `deep_research/`, `evaluation/`, `functionality/`, `games/`) and create your example directory. If a suitable category doesn't exist, you can propose a new one in your pull request. @@ -145,6 +163,12 @@ pre-commit run --all-files 4. **Code Review**: Address feedback from maintainers +### Recognition for Contributors + +- Your name will be added to the contributors list +- Outstanding examples may be featured on the AgentScope website, documentation, or social media +- You'll be part of a growing community shaping the future of agentic AI! + Thank you for contributing to AgentScope Samples! If you have any questions, feel free to reach out through: - **GitHub Discussions**: Ask questions and share experiences (use **English**) diff --git a/CONTRIBUTING_zh.md b/CONTRIBUTING_zh.md index c49a15b..5bfb169 100644 --- a/CONTRIBUTING_zh.md +++ b/CONTRIBUTING_zh.md @@ -46,6 +46,24 @@ ### 创建新示例 +#### 选择相关场景 + +我们鼓励涵盖以下领域的示例(但不限于): + +| 领域 | 示例想法 | +|------|---------| +| **金融** | 智能投顾、风险评估、财务报告分析 | +| **医疗健康** | 症状检查器、病历摘要、用药提醒 | +| **教育** | 个性化辅导、自动评分、知识问答检索 | +| **电商/零售** | 客户服务、产品推荐、库存管理 | +| **游戏/娱乐** | NPC 对话系统、动态故事生成器 | +| **办公自动化** | 会议摘要、自动回复邮件、日程协调 | +| **科研** | 文献综述助手、数据分析智能体 | +| **SRE/运维** | 告警分类、日志异常检测、根因分析、自动修复建议 | +| **通用工具** | 多智能体工作流、工具调用、记忆管理模式 | + +**提示**:选择您熟悉或热衷的领域——真实的用例具有最大的影响力! + #### 目录结构 选择合适的类别(`browser_use/`、`conversational_agents/`、`deep_research/`、`evaluation/`、`functionality/`、`games/`)并创建示例目录。如果不存在合适的类别,您可以在 pull request 中提议一个新类别。 @@ -145,6 +163,12 @@ pre-commit run --all-files 4. **代码审查**:处理维护者的反馈 +### 贡献者认可 + +- 您的名字将被添加到贡献者名单中 +- 优秀的示例可能会在 AgentScope 网站、文档或社交媒体上展示 +- 您将成为塑造智能体 AI 未来的不断增长的社区的一部分! + 感谢您为 AgentScope Samples 做出贡献!如有任何问题,欢迎通过以下方式与我们联系: - **GitHub Discussions**:提问和分享经验(使用**英文**)