Contribution Guide

This is the contribution guide for developers wanting to help out with Revolt.

Please first read our GitHub contributors guidance.

Backend (Rust)

The backend can be quite demanding at times, it is recommended that you have:

  • A modern multi-core CPU for Rust compilation.

  • About 30gb of free disk space to ensure everything can be installed and built.

    Tip: run cargo clean semi-frequently to delete old build artifacts.

  • At least 4gb of free memory.

    • Roughly half a gigabyte to run the Revolt stack
    • Betweeen 2-12gb to run Visual Studio Code with rust-analyzer
    • About 1gb to run a browser

You need the following prerequisites:

  • Rust (ideally through rustup)
  • Docker
  • Git
  • mold (optional but recommended, see mold)
  • If you'd like to run revite:
    • Node.js (v16 at minimum)
    • Yarn (enable corepack)

Please refer to the technical documentation found here.

Now you are ready to follow the development guide.

Frontend (Typescript)

You need the following prerequisties:

Please refer to the technical documentation found here.

Now you are ready to follow the development guide.

You should aim to test your changes on:

  • A Chromium browser (e.g. Chrome or Edge)
  • A WebKit browser (e.g. Safari or Epiphany)
  • Firefox