RMLRagMyLife

The public repository is not open yet. The GitHub features and the repository files mentioned below become available when it opens; until then, the Cloud waitlist on the home page is the way to hear about it.

Contributing to RagMyLife

Thanks for taking the time. RagMyLife is a local-first personal memory for your AI assistant; the core in this repository is licensed under PolyForm Shield 1.0.0 (see LICENSE and docs/NOTICE).

Before your first pull request: sign the CLA

Every contributor signs the Contributor License Agreement in docs/CLA.md once. It assigns the copyright in your contribution to the project's owner, so the project stays a single, cleanly owned asset. Send the signed agreement (PDF, or an e-mail stating your agreement) as described in docs/CLA.md §7; your handle and date are then added to docs/CONTRIBUTORS.md. Pull requests from people who have not signed are not merged.

What belongs here

The core: connectors (e-mail, WhatsApp import from backups, document libraries), processors, retrieval, the MCP gateway and the web fronts. The live WhatsApp capture (whatsapp-web.js) is a separate plugin with its own repository, license and terms-of-service notice; please do not add live-capture code here.

Working on the code

  • Layout v1: etc/ (instance configuration) and var/ (data, state, secrets) stay out of git. Start from etc.example/. Never commit real e-mails, phone numbers, hostnames or chat names.
  • Run bin/check before opening a PR (lint, compile, hermetic tests). The full suite runs on the maintainer's machine; CI runs the smoke set with etc.example.
  • Keep changes scoped: one topic per PR, with a short description of what changed and why.
  • Commit messages: imperative, prefixed by area (gateway:, email:, whatsapp:, docs:). English or Portuguese are both fine.
  • New dependencies need a compatible license (no GPL in the core) and a pin in the lock file.

Where to talk

Bugs and feature requests: GitHub Issues. Questions and ideas: GitHub Discussions (English or Portuguese) and the project Discord (link in the README). Security problems: docs/SECURITY.md.