Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (46 loc) · 2.31 KB

CONTRIBUTING.md

File metadata and controls

59 lines (46 loc) · 2.31 KB

Welcome to the MemMachine Project

Thank you for your interest in contributing to MemMachine! We are a community-driven open-source project, and we welcome contributions from everyone. Whether you're a new developer or a seasoned pro, your help is invaluable.

This guide will walk you through the process of getting started and making your first contribution.

1. Before You Get Started

Before you make a contribution, please take a moment to review these important documents:

  • Code of Conduct: Our community's values and expectations for all contributors.
  • Governance: The rules and principles by which our project is managed.

2. How to Contribute

We have two main areas for contributions: the core Python source code and the project's documentation. To make your process as smooth as possible, we have created specific guides for each.

  • For Core Code Contributions: If you'd like to contribute code, fix a bug, or propose a new feature, please read our Core Contribution Guide.
  • For Documentation Contributions: If you want to improve a typo, correct a broken link, or add a new guide, please read our Documentation Contribution Guide.

3. General Contribution Workflow

All contributions, regardless of type, should follow this general workflow:

  1. Fork the Repository: Fork the project on GitHub to your own account.
  2. Clone Your Fork: Clone your forked repository to your local machine: 
    git clone https://github.com/YOUR_USERNAME/MemMachine.git
cd MemMachine
  3. Create a Branch: Create a new branch for your changes: 
    git checkout -b feat/your-feature-name
  4. Make Your Changes: Follow the instructions in the relevant guide (Core or Documentation).
  5. Sign Your Commits: All commits must be signed using the -sS flags. This ensures a verifiable chain of custody for all code. For instructions to create GPG Keys used for signing, refer to the Microsoft Commit Signing wiki page for step-by-step instructions.
  6. Push and Open a Pull Request: Push your changes to your fork and open a pull request against our main branch.

We look forward to your contributions!