Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
151 lines (117 loc) · 4.14 KB

CONTRIBUTING.md

File metadata and controls

151 lines (117 loc) · 4.14 KB

Contributing to REPRAM

Thank you for your interest in contributing to REPRAM! We welcome contributions from the community and are grateful for any help you can provide.

Code of Conduct

By participating in this project, you agree to maintain a respectful and collaborative environment. We expect all contributors to:

  • Be respectful and inclusive
  • Accept constructive criticism gracefully
  • Focus on what's best for the project and community
  • Show empathy towards other contributors

How to Contribute

1. Getting Started

  1. Fork the repository to your GitHub account
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/REPRAM.git
cd REPRAM
  3. Add upstream remote: 
    git remote add upstream https://github.com/TickTockBent/REPRAM.git
  4. Create a feature branch: 
    git checkout -b feature/your-feature-name

2. Before You Code

  • Read the documentation:

  • Check existing issues to see if someone's already working on it

  • Open an issue to discuss significant changes before implementing

3. Development Guidelines

Code Standards

Go (node binary):

  • Follow Effective Go guidelines
  • Use gofmt for code formatting
  • Add comments for exported functions and types

TypeScript (MCP server / unified node):

  • Strict TypeScript (strict: true in tsconfig)
  • Use descriptive variable names
  • Prefer interfaces over type aliases for public contracts
  • No any unless interfacing with untyped external APIs

Both languages:

  • Keep functions focused and small
  • Test new functionality with unit tests

Testing Requirements

  • Write tests for new functionality
  • Ensure all tests pass: 
    make test                             # Go (83 tests)
cd repram-mcp && npm test             # TypeScript (248 tests)
  • Include both unit and integration tests where appropriate

Commit Guidelines

  • Use clear, descriptive commit messages
  • Follow conventional commits format: 
    feat: add new gossip protocol implementation
fix: resolve memory leak in storage cleanup
docs: update API documentation
test: add tests for TTL enforcement
refactor: simplify node initialization
  • Keep commits atomic and focused

4. Submitting a Pull Request

  1. Update your fork:

    git fetch upstream
git rebase upstream/main

  2. Run all checks locally:

    make build
make test

  3. Push to your fork:

    git push origin feature/your-feature-name

  4. Create Pull Request:

    • Use a clear, descriptive title
    • Reference any related issues
    • Describe what changed and why
    • Include testing instructions

Development Setup

Prerequisites

  • Go 1.22 or higher
  • Node.js 18+ (for MCP server development)
  • Make
  • Git
  • Docker (optional, for containerized testing)

Quick Start

# Clone and setup
git clone https://github.com/YOUR_USERNAME/REPRAM.git
cd REPRAM

# Build and test the Go node
make build
make test

# Build and test the TypeScript node / MCP server
cd repram-mcp && npm install && npm run build && npm test

# Start a Go node
make run

# Or start a TypeScript node (standalone HTTP server)
cd repram-mcp && npx repram-mcp --standalone

Architecture Principles

When contributing, please maintain:

  1. Zero-knowledge nodes - Nodes never interpret data
  2. Privacy through transience - The network is safe because it forgets; encryption is the client's concern
  3. Ephemeral by design - Everything has a TTL, expired data is permanently gone
  4. Permissionless reads - No auth at node level
  5. Single binary - One cmd/repram entry point, cluster-capable by default

Questions?

License

By contributing, you agree that your contributions will be licensed under the same license as the project (see LICENSE file).