CONTRIBUTING.md

Contributing to MemLens

Thank you for your interest in contributing to MemLens! We welcome contributions from the community.

Getting Started

1. Fork the repository
2. Clone your fork: git clone https://github.com/your-username/MemLens.git
3. Install dependencies: pip install -e ".[dev]"
4. Create a branch: git checkout -b feature/your-feature

Development Setup

# Create virtual environment
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest

# Run linting
black memlens/
isort memlens/
mypy memlens/

Making Changes

1. Make your changes
2. Add tests for new functionality
3. Ensure all tests pass: pytest
4. Update documentation if needed
5. Submit a pull request

Code Style

• Follow PEP 8
• Use type hints
• Write docstrings for all public functions
• Keep functions focused and small

Commit Messages

• Use present tense: "Add feature" not "Added feature"
• Use imperative mood: "Move cursor to..." not "Moves cursor to..."
• Limit first line to 72 characters

Questions?

• Open an issue
• Join our Discord
• Email: hello@memlens.dev

Thank you for contributing!