Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
103 lines (73 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

103 lines (73 loc) · 2.33 KB

Contributing to Memobase

Thank you for your interest in contributing to Memobase! This document provides guidelines and instructions for contributing to the project.

Table of Contents

Development Setup

Server Development

Prerequisites

  • Python (>= 3.11)
  • Docker
  • Git

Setting Up the Environment

  1. Fork the repository

  2. Clone your fork:

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

  3. Set up the virtual environment:

    cd src/server/api
python3 -m venv .venv
source .venv/bin/activate
pip3 install -r requirements.txt

  4. Run the server:

For more detailed information, refer to the server documentation.

Development Workflow

  1. Create a branch for your feature or bugfix:

    git checkout -b feature/your-feature-name

  2. Make your changes with frequent commits:

    git commit -m "feat: add your feature"

    Recommended commit message style

  3. Write tests for your changes

  4. Update documentation as needed

Pull Request Process

  1. Rebase your branch onto the latest dev branch:

    git checkout dev
git pull upstream dev
git checkout your-branch
git rebase dev

  2. Fix up commits to maintain clean history:

    git rebase -i dev

  3. Before submitting, ensure:

    • All tests pass
    • Code is properly formatted
    • Documentation is updated

  4. Submit your PR with:

    • A clear title following the commit message format
    • A comprehensive description of your changes
    • References to any related issues

PR or Issue?

  • We will not accept document typo fix PR, just make an issue if you find any typo.

Communication

If you have questions or need help, please:

  • Check existing issues and documentation
  • Create a new issue for discussion
  • Join our Discord

Thank you for contributing to Memobase!
⚡