Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
141 lines (96 loc) · 3.92 KB

CONTRIBUTING.md

File metadata and controls

141 lines (96 loc) · 3.92 KB

Contributing to Relay

Thanks for your interest in contributing to Relay! This document covers how to get started, how to submit changes, and where to find help.

Get Involved

Join us in the Matrix room to ask questions, discuss ideas, or just say hello:

#relayapp:matrix.org

Building from Source

Relay is a native macOS app built with SwiftUI and Xcode.

Requirements

  • macOS 26.0 (Tahoe) or later
  • Xcode 26.0 or later

Steps

  1. Clone the repository:

    git clone https://github.com/subpop/Relay.git
cd Relay

  2. Create your local secrets file from the template:

    cp Secrets.xcconfig.example Secrets.xcconfig

    Open Secrets.xcconfig and fill in your values:

    Secrets.xcconfig is gitignored and will not be committed.

  3. Open Relay.xcodeproj in Xcode.

  4. Xcode will automatically resolve Swift Package dependencies.

  5. Select the Relay scheme and build (Cmd+B) or run (Cmd+R).

Project Structure

Directory Description
Relay/ App target -- SwiftUI views and app entry point
RelayKit/ Framework target -- Matrix Rust SDK integration, services, and view models
Packages/RelayInterface/ Local Swift package -- shared protocols and model types

Local Homeserver for Screenshots

A seed script is included to spin up a local Matrix homeserver populated with realistic data. This is useful for taking screenshots, testing UI with real room/message data, or working on features without connecting to a live server.

Requirements

Running the Script

./scripts/seed-homeserver.sh

To use a different container runtime:

CONTAINER_RUNTIME=podman ./scripts/seed-homeserver.sh

The script starts a continuwuity homeserver in a container and seeds it with users, spaces, rooms, and messages for a fictional software company called "Pebble". It takes about 30 seconds to complete.

Signing In

After the script finishes, open Relay (Debug build) and sign in on the sign-in page:

Field Value
Matrix ID @alex:pebble.dev
Password pebble123
Homeserver URL http://localhost:8008

The "Homeserver URL" field is only available in Debug builds.

User Avatars

Place avatar images in scripts/profiles/, named by username (e.g. morgan.png, priya.jpg). The script uploads any images it finds and skips users without one.

Managing the Server

# Stop the server
docker stop relay-homeserver

# Start it again
docker start relay-homeserver

# Delete everything and start fresh
docker rm -v relay-homeserver && docker volume rm relay-homeserver-data

Replace docker with your container runtime if different.

Submitting Changes

  1. Fork the repository and create a branch from main.
  2. Make your changes. Try to keep commits focused and atomic.
  3. Use imperative mood, sentence-case commit messages (e.g. "Add thread support to timeline view").
  4. Open a pull request against main with a clear description of what your change does and why.

Reporting Issues

Open an issue on the GitHub issue tracker. Include steps to reproduce the problem, what you expected to happen, and what actually happened. Screenshots or logs are always helpful.

License

By contributing to Relay, you agree that your contributions will be licensed under the Apache License 2.0.