You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+45-3Lines changed: 45 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -185,10 +185,27 @@ examples/
185
185
186
186
### Adding New Examples
187
187
188
-
We highly encourage contributions of new examples that showcase the capabilities of AgentScope.
189
-
Please add them to the `examples/` directory with a clear README explaining the purpose and usage of the example.
188
+
We highly encourage contributions of new examples that showcase the capabilities of AgentScope! Your examples help others learn and get inspired.
190
189
191
-
Now our examples are organized into subdirectories based on their type:
190
+
**📝 About the Examples Directory:**
191
+
192
+
To maintain code quality and keep the repository accessible for everyone, we've designed the `examples/` directory in the main AgentScope repository to focus on **demonstrating AgentScope's functionalities**. Think of these as educational references and feature showcases that help developers quickly understand what AgentScope can do.
193
+
194
+
**What makes a great example here:**
195
+
- Clearly demonstrates specific AgentScope features or capabilities
196
+
- Easy to understand and follow along
197
+
- Serves as a learning material or reference implementation
198
+
- Focused and concise
199
+
200
+
**For More Complex Applications:**
201
+
202
+
Have you built something amazing with AgentScope? Perhaps a more sophisticated, production-ready application? That's fantastic! 🎉
203
+
204
+
We'd love to see your work in our **[agentscope-samples](https://github.com/agentscope-ai/agentscope-samples)** repository. This dedicated space is perfect for showcasing complete, real-world applications and sharing your AgentScope-based projects with the community. It's a great way to inspire others and demonstrate the full potential of the AgentScope ecosystem!
205
+
206
+
**Example Organization:**
207
+
208
+
Examples in the main repository are organized into subdirectories based on their type:
192
209
193
210
-`examples/agent/` for specialized agents
194
211
-`examples/functionality/` for showcasing specific functionalities of AgentScope
@@ -208,6 +225,31 @@ examples/
208
225
└── ... # The other scripts
209
226
```
210
227
228
+
### Adding New Memory Databases
229
+
230
+
The memory module in AgentScope currently supports:
231
+
232
+
-**In-memory storage**: For lightweight, temporary memory needs
233
+
-**Relational databases via SQLAlchemy**: For persistent, structured data storage
234
+
-**NoSQL databases**: For flexible schema requirements (e.g., Redis)
235
+
236
+
**⚠️ Important Notice:**
237
+
238
+
For **relational databases**, we use **SQLAlchemy** as a unified abstraction layer. SQLAlchemy already supports a wide
239
+
range of SQL databases including PostgreSQL, MySQL, SQLite, Oracle, Microsoft SQL Server, and many others.
240
+
241
+
**Therefore, we do not accept separate implementations for relational databases that are already supported by SQLAlchemy.**
242
+
If you need support for a specific relational database, please ensure it works through the existing SQLAlchemy integration.
243
+
244
+
**If you wish to contribute a new memory database implementation**, please consider:
245
+
246
+
1.**For relational databases**: Use the existing SQLAlchemy integration.
247
+
248
+
2.**For NoSQL databases**: If you're adding support for a new NoSQL database (e.g., MongoDB, Cassandra), please:
249
+
- Implement a new memory class that extends the appropriate base class
0 commit comments