update: readme

sairin1202 · sairin1202 · commit 805fe0189ac3 · 2025-08-03T19:52:27.000+08:00
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,244 @@
+# Contributing to MemU
+
+Thank you for your interest in contributing to MemU! This document provides guidelines and information for contributors.
+
+## 🌟 Ways to Contribute
+
+We welcome all types of contributions:
+
+- 🐛 **Bug Reports** - Help us identify and fix issues
+- 💡 **Feature Requests** - Suggest new capabilities and improvements  
+- 📝 **Documentation** - Improve guides, examples, and API docs
+- 🔧 **Code Contributions** - Add features, fix bugs, optimize performance
+- 🧪 **Testing** - Write tests, improve coverage, test edge cases
+- 🎨 **UI/UX** - Enhance user experience and interface design
+- 🌐 **Translations** - Help make MemU accessible globally
+- 📢 **Community** - Help others in discussions and support channels
+
+## 🚀 Quick Start for Contributors
+
+### Prerequisites
+- Python 3.8+
+- Git
+- A code editor (VS Code recommended)
+
+### Development Setup
+
+```bash
+# 1. Fork the repository on GitHub
+# 2. Clone your fork locally
+git clone https://github.com/YOUR_USERNAME/MemU.git
+cd MemU
+
+# 3. Create a virtual environment
+python -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+
+# 4. Install development dependencies
+pip install -e ".[dev]"
+
+# 5. Install pre-commit hooks
+make pre-commit-install
+
+# 6. Verify setup by running tests
+make test
+```
+
+### Available Commands
+
+```bash
+make help              # Show all available commands
+make test              # Run tests
+make coverage          # Run tests with coverage report
+make lint              # Run linting (flake8, mypy)
+make format            # Format code (black, isort)
+make pre-commit-run    # Run all pre-commit checks
+make clean             # Clean build artifacts
+```
+
+## 🔧 Development Guidelines
+
+### Code Style
+- Follow **PEP 8** Python style guidelines
+- Use **Black** for code formatting (line length: 88)
+- Use **isort** for import sorting
+- Use **type hints** for all functions and methods
+- Write **docstrings** for public APIs
+
+### Code Quality Standards
+- Maintain **test coverage > 80%**
+- All code must pass **linting** (flake8, mypy)
+- Use **meaningful variable and function names**
+- Keep functions **focused and small**
+- Follow **SOLID principles**
+
+### Testing
+```bash
+# Run all tests
+pytest
+
+# Run with coverage
+pytest --cov=memu --cov-report=html
+
+# Run specific test file
+pytest tests/test_memory_agent.py
+
+# Run tests with specific marker
+pytest -m "not slow"
+```
+
+## 📝 Submitting Changes
+
+### Before You Start
+1. **Search existing issues** to avoid duplicates
+2. **Create an issue** for new features or major changes
+3. **Discuss your approach** in the issue before implementing
+
+### Creating Issues
+
+When reporting bugs, please include:
+- **Environment details** (Python version, OS, MemU version)
+- **Reproduction steps** with minimal code example
+- **Expected vs actual behavior**
+- **Error messages** or stack traces
+
+For feature requests, please describe:
+- **The problem** you're trying to solve
+- **Proposed solution** or approach
+- **Alternative solutions** you've considered
+- **Use cases** and examples
+
+### Pull Request Process
+
+1. **Create a feature branch**
+   ```bash
+   git checkout -b feature/amazing-feature
+   # or for bug fixes
+   git checkout -b bugfix/fix-memory-leak
+   ```
+
+2. **Make your changes**
+   - Write clear, descriptive commit messages
+   - Keep commits focused and atomic
+   - Add tests for new functionality
+   - Update documentation as needed
+
+3. **Test your changes**
+   ```bash
+   make test
+   make lint
+   make coverage
+   ```
+
+4. **Submit pull request**
+   - Use descriptive title and description
+   - Reference related issues (e.g., "Fixes #123")
+   - Include testing instructions
+   - Add screenshots for UI changes
+
+### Commit Message Format
+
+Use conventional commit format:
+
+```
+type(scope): description
+
+Examples:
+feat(memory): add semantic search functionality
+fix(llm): resolve OpenAI timeout issues  
+docs(readme): update installation instructions
+test(agent): add unit tests for memory retrieval
+refactor(core): restructure memory storage logic
+```
+
+**Types:**
+- `feat`: New feature
+- `fix`: Bug fix
+- `docs`: Documentation changes
+- `test`: Adding or fixing tests
+- `refactor`: Code restructuring without feature changes
+- `perf`: Performance improvements
+- `chore`: Maintenance tasks
+
+## 🎯 Current Priorities
+
+We're currently focusing on:
+
+| Priority | Area | Description |
+|----------|------|-------------|
+| 🔥 **High** | Multi-modal Support | Images, audio, video memory processing |
+| 🔥 **High** | Performance | Memory retrieval optimization, caching |
+| 🔥 **High** | LLM Providers | Additional provider integrations |
+| 🟡 **Medium** | Enterprise Features | SSO, RBAC, audit logging |
+| 🟡 **Medium** | Mobile SDKs | React Native, Flutter support |
+| 🟢 **Low** | UI Improvements | Dashboard, memory visualization |
+
+## 🏷️ Issue Labels
+
+| Label | Description |
+|-------|-------------|
+| `good first issue` | Perfect for newcomers |
+| `help wanted` | Extra attention needed |
+| `bug` | Something isn't working |
+| `enhancement` | New feature request |
+| `documentation` | Improvements to docs |
+| `performance` | Performance optimization |
+| `breaking change` | Requires version bump |
+| `priority:high` | Urgent issues |
+| `priority:medium` | Important issues |
+| `priority:low` | Nice to have |
+
+## 📋 Code Review Process
+
+### For Contributors
+- Be open to feedback and constructive criticism
+- Respond promptly to review comments
+- Make requested changes in new commits (don't force push)
+- Ask questions if feedback is unclear
+
+### For Reviewers
+- Be constructive and respectful in feedback
+- Focus on code quality, maintainability, and project goals
+- Suggest improvements with explanations
+- Approve when ready, request changes when needed
+
+## 🔒 Security
+
+**Reporting Security Issues:**
+- **DO NOT** create public issues for security vulnerabilities
+- Email security issues privately to [security@nevamind.ai](mailto:security@nevamind.ai)
+- Include detailed reproduction steps and impact assessment
+- We'll acknowledge receipt within 24 hours
+
+## 📄 License and Attribution
+
+By contributing to MemU, you agree that:
+- Your contributions will be licensed under the **Apache License 2.0**
+- You have the right to contribute the code/content
+- Your contribution doesn't violate any third-party rights
+
+## 🌍 Community Guidelines
+
+- Be respectful and inclusive
+- Follow our [Code of Conduct](CODE_OF_CONDUCT.md)
+- Help others learn and grow
+- Share knowledge and best practices
+- Celebrate diverse perspectives and experiences
+
+## 📞 Getting Help
+
+| Channel | Best For |
+|---------|----------|
+| 💬 [Discord](https://discord.gg/hQZntfGsbJ) | Real-time chat, quick questions |
+| 🗣️ [GitHub Discussions](https://github.com/NevaMind-AI/MemU/discussions) | Feature discussions, Q&A |
+| 🐛 [GitHub Issues](https://github.com/NevaMind-AI/MemU/issues) | Bug reports, feature requests |
+| 📧 [Email](mailto:contact@nevamind.ai) | Private inquiries |
+
+## 🎉 Recognition
+
+Contributors are recognized in:
+- README.md contributors section
+- Release notes for significant contributions
+- Our [Contributors](https://github.com/NevaMind-AI/MemU/graphs/contributors) page
+
+Thank you for helping make MemU better! 🚀
diff --git a/Makefile b/Makefile
@@ -26,15 +26,15 @@ test: ## Run tests
 	pytest
 
 coverage: ## Run tests with coverage
-	pytest --cov=personalab --cov-report=html --cov-report=term
+	pytest --cov=memu --cov-report=html --cov-report=term
 
 lint: ## Run linting
-	flake8 personalab tests
-	mypy personalab
+	flake8 memu tests
+	mypy memu
 
 format: ## Format code
-	black personalab tests
-	isort personalab tests
+	black memu tests
+	isort memu tests
 
 build: clean ## Build package
 	python -m build
diff --git a/README.md b/README.md
@@ -18,10 +18,10 @@
 With **memU**, you can build AI companions that truly remember you. They learn who you are, what you care about, and grow alongside you through every interaction.
 
 ### 🥇 92.9% Accuracy - 💰 90% Cost Reduction - 🤖 AI Companion Specialized
+- ✅ **AI Companion Specialization** - Adapt to AI companions application
 - ✅ **92.9% Accuracy** - State-of-the-art score in Locomo benchmark
 - ✅ **Up to 70% Cost Reduction** - Through optimized infrastructure
 - ✅ **Advanced Retrieval Strategies** - Multiple methods including semantic search, hybrid search, contextual retrieval
-- ✅ **AI Companion Specialization** - Adapt to AI companions application
 - ✅ **24/7 Support** - For enterprise customers
 
 ---
@@ -53,6 +53,7 @@ The fastest way to integrate your application with memU. Perfect for teams and i
 #### Step-by-step
 
 **Step 1:** Create account & get your API key
+
 **Step 2:** Add three lines to your code
 ```python
 pip install memu-py
@@ -70,22 +71,18 @@ memory_agent = MemoryAgent()
 For organizations requiring maximum security, customization, control and best quality:
 
 - **Commercial License** - Full proprietary features, commercial usage rights, white-labeling options
-
 - **Custom Development** - SSO/RBAC integration, dedicated algorithm team for scenario-specific framework optimization
-
 - **Intelligence & Analytics** - User behavior analysis, real-time production monitoring, automated agent optimization
-
 - **Premium Support** - 24/7 dedicated support, custom SLAs, professional implementation services
-
 📧 **Enterprise Inquiries:** [contact@nevamind.ai](mailto:contact@nevamind.ai)
 
 
 ### 🏠 Self-Hosting (Community Edition)
 For users and developers who prefer local control, data privacy, or customization:
 
-* ✅ **Data Privacy** - Keep sensitive data within your infrastructure
-* ✅ **Customization** - Modify and extend the platform to fit your needs
-* ✅ **Cost Control** - Avoid recurring cloud fees for large-scale deployments
+* **Data Privacy** - Keep sensitive data within your infrastructure
+* **Customization** - Modify and extend the platform to fit your needs
+* **Cost Control** - Avoid recurring cloud fees for large-scale deployments
 
 🚀 **Coming Soon!**
 
@@ -275,40 +272,14 @@ Try MemU instantly in your browser: [**🔗 Interactive Demo**](https://demo.nev
 
 ## 🤝 Contributing
 
-![Contributing Flow](assets/contributing-flow.png)
+We build trust through open-source collaboration. Your creative contributions drive memU's innovation forward. Explore our GitHub issues and projects to get started and make your mark on the future of memU.
 
-### **Join Our Mission**
+📋 **[Read our detailed Contributing Guide →](CONTRIBUTING.md)**
 
-Help us build the future of AI memory! We welcome contributions of all kinds.
 
-**🌟 Ways to Contribute:**
-- 🐛 Report bugs and suggest features
-- 📝 Improve documentation and examples  
-- 🔧 Add new LLM providers and integrations
-- 🧪 Write tests and improve code quality
-
-### **Quick Contribution Guide**
-
-```bash
-# 1. Fork and clone
-git clone https://github.com/YOUR_USERNAME/MemU.git
-
-# 2. Create feature branch
-git checkout -b feature/amazing-feature
-
-# 3. Make changes and test
-pip install -e .
-python -m pytest
-
-# 4. Submit PR
-git push origin feature/amazing-feature
-```
+### **📄 License**
 
-**🎯 Current Priorities:**
-- Multi-modal memory support (images, audio)
-- Performance optimizations
-- Additional embedding providers
-- Enterprise security features
+By contributing to MemU, you agree that your contributions will be licensed under the **Apache License 2.0**.
 
 ---
 
