Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
142 lines (100 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

142 lines (100 loc) · 3.44 KB

Contributing to Open RLM Memory

Thank you for your interest in contributing to Open RLM Memory! This document provides guidelines for contributing to the project.

How to Contribute

We welcome contributions in many forms:

  • Reporting Bugs: Help us fix issues by reporting bugs
  • Suggesting Features: Request new features or enhancements
  • Writing Code: Submit pull requests with bug fixes or features
  • Improving Documentation: Fix typos, improve clarity, add examples
  • Answering Questions: Help other users in discussions

Development Setup

Follow these steps to set up your development environment:

Clone Repository

git clone https://github.com/TykoDev/open-rlm-memory.git
cd open-rlm-memory

Backend Setup

cd backend
python -m venv venv
source venv/bin/activate  # Windows: .\venv\Scripts\activate
pip install -r requirements.txt

Frontend Setup

cd frontend
npm install

Environment Configuration

cp .env.example .env
# Edit .env with your local configuration

Run Tests

# Backend
cd backend
pytest

# Frontend
cd frontend
npm run test

Submission Guidelines

Branching Strategy

Use descriptive branch names:

feature/add-user-authentication
bugfix/memory-delete-error
docs/update-api-documentation

Commit Messages

Follow Conventional Commits:

feat: add user authentication
fix: resolve search performance issue
docs: update API documentation
style: format code with ruff
refactor: simplify cache service
test: add unit tests for RLM service
chore: update dependencies

Pull Request Process

  1. Update your branch with latest main
  2. Ensure all tests pass locally
  3. Create pull request to main branch
  4. Fill out the PR template completely
  5. Link any related issues
  6. Request review from maintainers

Code Review

  • Be open to constructive feedback
  • Review others' PRs when possible
  • Keep feedback constructive and actionable

Coding Standards

Python (Backend)

  • Style: Follow PEP 8 and use ruff for linting
  • Type Hints: Include type hints on all functions
  • Documentation: Add docstrings to public classes and methods
  • Testing: Write tests for new functionality
  • Async: Use async/await for I/O operations

TypeScript (Frontend)

  • Style: Use ESLint with Prettier
  • Type Safety: No any types, enable strict mode
  • Components: Use functional components with proper typing
  • Testing: Write tests with Vitest and @testing-library/react

Testing Requirements

  • Backend: All PRs must pass pytest
  • Frontend: All PRs must pass npm run test and npm run typecheck
  • Coverage: Aim for 80%+ coverage on new code
  • Bug Fixes: Include regression tests

Documentation Updates

  • Update relevant documentation for user-facing changes
  • Update CHANGELOG.md for notable changes
  • Ensure code examples are accurate

Questions?

License

By contributing, you agree that your contributions will be licensed under the AGPLv3. See also COMMERCIAL-LICENSE.md for commercial licensing.

Thank you for contributing to Open RLM Memory!