Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (31 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

42 lines (31 loc) · 1.61 KB
Raw

R2R Contribution Guide

Quick Start

  • Pre-Discussion: Feel free to propose your ideas via issues, Discord if you want to get early feedback.
  • Code of Conduct: Adhere to our Code of Conduct in all interactions.
  • Pull Requests (PRs): Follow the PR process for contributions.

Local Development

For developing and running the R2R server locally (outside of Docker), we recommend using uv. You can easily run the server by injecting your environment variables from a .env file using the --env-file flag.

First, copy docker/env/r2r-full.env to .env in the root directory and configure it. Make sure to update any Docker-specific hostnames (like postgres or unstructured) to localhost.

Then, use the following command to start the server:

uv run --env-file .env r2r-serve --host ${R2R_HOST:-"localhost"} --port ${R2R_PORT:-"7272"}

Pull Request Process

  1. Dependencies: Ensure all dependencies are necessary and documented.
  2. Documentation: Update README.md with any changes to interfaces, including new environment variables, exposed ports, and other relevant details.
  3. Versioning: Increment version numbers in examples and README.md following SemVer.
  4. Review: A PR can be merged after receiving approval from at least two other developers. If you lack merge permissions, request a review for merging.

Attribution

This Code of Conduct adapts from the Contributor Covenant, version 1.4.