Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 2.15 KB

CONTRIBUTING.md

File metadata and controls

76 lines (52 loc) · 2.15 KB

Contributing to MemoryMatrix

Thank you for considering contributing to MemoryMatrix! We welcome all contributions, whether it's a bug report, feature implementation, or documentation improvement. Together, we can build a robust open-source system that works across AI tools.

How to Get Started

  1. Fork the repository:
    Create a fork of the MemoryMatrix repository to your GitHub account.

  2. Clone your fork locally:

    git clone https://github.com/your-username/memory-matrix.git
cd memory-matrix

  3. Create a feature branch:

    git checkout -b feature/your-feature-name

  4. Make your changes:
    Implement your feature, fix a bug, or enhance the documentation.

Code Guidelines

  • Follow PEP8 coding style for Python code
  • Add comments for complex or critical portions of code
  • Write tests for new code - place them in the tests/ folder
  • Keep functions modular, reusable, and as simple as possible

Run tests before pushing changes:

pytest

Submitting Changes

Submitting a Pull Request

After you've made changes:

  1. Commit your code:
    Write clean, descriptive commit messages:

    git commit -m "Add feature: semantic memory querying"

  2. Push your changes:

    git push origin feature/your-feature-name

  3. Open a Pull Request:
    Go to the original repository (https://github.com/MaZyAkAkUn/memory-matrix) and click "New Pull Request." Follow the template to submit your changes.

Pull Request Review

  • A maintainer will review your PR within a few days
  • If any changes are needed, you'll be notified in the comments

Reporting Bugs / Requesting Features

Have an idea or found a bug? Open an issue on GitHub:

  1. Go to GitHub Issues
  2. Click "New Issue"
  3. Provide as much detail as you can (e.g., steps to reproduce a bug or a clear description of the new feature)

Community Guidelines

We want MemoryMatrix to be a welcoming and collaborative space! Please:

  • Be respectful and constructive in your interactions
  • Provide detailed feedback when suggesting changes

We're excited to see how you'll help improve MemoryMatrix!