Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (46 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

65 lines (46 loc) · 1.38 KB
Raw

Contributing to MemForge 🧠

Thank you for your interest in contributing to MemForge! This document provides guidelines for contributing.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/MemForge.git
  3. Install in development mode: pip install -e .
  4. Run tests: python -m pytest tests/

Development Setup

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

# Install
pip install -e .

# Run tests
python -m pytest tests/ -v

# Run CLI
python -m memforge demo

Code Style

  • Follow PEP 8
  • Use type hints where possible
  • Add docstrings to all public functions and classes
  • Keep functions focused and small

Commit Messages

Follow the Angular commit convention:

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation changes
  • refactor: Code refactoring
  • test: Test additions/changes
  • chore: Maintenance tasks

Pull Request Process

  1. Create a feature branch from main
  2. Make your changes with tests
  3. Ensure all tests pass
  4. Submit a PR with a clear description

Issue Reports

When filing issues, please include:

  • Python version
  • Operating system
  • Minimal reproduction steps
  • Expected vs actual behavior

License

By contributing, you agree that your contributions will be licensed under the MIT License.