@@ -415,7 +415,7 @@ View detailed experimental data: [memU-experiment](https://github.com/NevaMind-A
415415<div align =" center " >
416416
417417<a href =" https://github.com/TEN-framework/ten-framework " ><img src =" https://avatars.githubusercontent.com/u/113095513?s=200&v=4 " alt =" Ten " height =" 40 " style =" margin : 10px ;" ></a >
418- <a href =" GitHub - openagents-org/ openagents: OpenAgents - AI Agent Networks for Open Collaboration " ><img src =" assets/partners/openagents.png " alt =" OpenAgents " height =" 40 " style =" margin : 10px ;" ></a >
418+ <a href =" https:// openagents.org " ><img src =" assets/partners/openagents.png " alt =" OpenAgents " height =" 40 " style =" margin : 10px ;" ></a >
419419<a href =" https://github.com/milvus-io/milvus " ><img src =" https://miro.medium.com/v2/resize:fit:2400/1*-VEGyAgcIBD62XtZWavy8w.png " alt =" Milvus " height =" 40 " style =" margin : 10px ;" ></a >
420420<a href =" https://xroute.ai/ " ><img src =" assets/partners/xroute.png " alt =" xRoute " height =" 40 " style =" margin : 10px ;" ></a >
421421<a href =" https://jaaz.app/ " ><img src =" assets/partners/jazz.png " alt =" Jazz " height =" 40 " style =" margin : 10px ;" ></a >
@@ -427,6 +427,62 @@ View detailed experimental data: [memU-experiment](https://github.com/NevaMind-A
427427
428428---
429429
430+ ## 🤝 How to Contribute
431+
432+ We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help is appreciated.
433+
434+ ### Getting Started
435+
436+ To start contributing to MemU, you'll need to set up your development environment:
437+
438+ #### Prerequisites
439+ - Python 3.13+
440+ - [ uv] ( https://github.com/astral-sh/uv ) (Python package manager)
441+ - Git
442+
443+ #### Setup Development Environment
444+
445+ ``` bash
446+ # 1. Fork and clone the repository
447+ git clone https://github.com/YOUR_USERNAME/memU.git
448+ cd memU
449+
450+ # 2. Install development dependencies
451+ make install
452+ ```
453+
454+ The ` make install ` command will:
455+ - Create a virtual environment using ` uv `
456+ - Install all project dependencies
457+ - Set up pre-commit hooks for code quality checks
458+
459+ #### Running Quality Checks
460+
461+ Before submitting your contribution, ensure your code passes all quality checks:
462+
463+ ``` bash
464+ make check
465+ ```
466+
467+ The ` make check ` command runs:
468+ - ** Lock file verification** : Ensures ` pyproject.toml ` consistency
469+ - ** Pre-commit hooks** : Lints code with Ruff, formats with Black
470+ - ** Type checking** : Runs ` mypy ` for static type analysis
471+ - ** Dependency analysis** : Uses ` deptry ` to find obsolete dependencies
472+
473+ ### Contributing Guidelines
474+
475+ For detailed contribution guidelines, code standards, and development practices, please see [ CONTRIBUTING.md] ( CONTRIBUTING.md ) .
476+
477+ ** Quick tips:**
478+ - Create a new branch for each feature or bug fix
479+ - Write clear commit messages
480+ - Add tests for new functionality
481+ - Update documentation as needed
482+ - Run ` make check ` before pushing
483+
484+ ---
485+
430486## 📄 License
431487
432488[ Apache License 2.0] ( LICENSE.txt )
@@ -435,7 +491,7 @@ View detailed experimental data: [memU-experiment](https://github.com/NevaMind-A
435491
436492## 🌍 Community
437493
438- - ** GitHub Issues** : [ Report bugs & request features] ( NevaMind-AI/memU )
494+ - ** GitHub Issues** : [ Report bugs & request features] ( https://github.com/ NevaMind-AI/memU/issues )
439495- ** Discord** : [ Join the community] ( https://discord.com/invite/hQZntfGsbJ )
440496- ** X (Twitter)** : [ Follow @memU_ai] ( https://x.com/memU_ai )
441497- ** Contact** : info@nevamind.ai
0 commit comments