clash-verge-rev/CONTRIBUTING.md

CONTRIBUTING

Thank you for your interest in contributing to Clash Verge Rev! This guide provides instructions to help you set up your development environment and start contributing effectively.

Internationalization (i18n)

We welcome translations and improvements to existing locales. For details on contributing translations, please see CONTRIBUTING_i18n.md.

Development Setup

Before contributing, you need to set up your development environment. Follow the steps below carefully.

Prerequisites

1. Install Rust and Node.js
   Our project requires both Rust and Node.js. Follow the official installation instructions here.

Windows Users

Note

Windows ARM users must also install LLVM (including clang) and set the corresponding environment variables.
The ring crate depends on clang when building on Windows ARM.

Additional steps for Windows:

• Ensure Rust and Node.js are added to your system PATH.

• Install the GNU patch tool.

• Use the MSVC toolchain for Rust:

rustup target add x86_64-pc-windows-msvc
rustup set default-host x86_64-pc-windows-msvc

Install Node.js Package Manager

Enable corepack:

corepack enable

Install Project Dependencies

Node.js dependencies:

pnpm install

Ubuntu-only system packages:

sudo apt-get install -y libxslt1.1 libwebkit2gtk-4.1-dev libayatana-appindicator3-dev librsvg2-dev patchelf

Download the Mihomo Core Binary (Automatic)

pnpm run prebuild
pnpm run prebuild --force  # Re-download and overwrite Mihomo core and service binaries

Run the Development Server

pnpm dev           # Standard
pnpm dev:diff      # If an app instance already exists
pnpm dev:tauri     # Run Tauri development mode

Build the Project

Standard build:

pnpm build

Fast build for testing:

pnpm build:fast

Clean Build

pnpm clean

Portable Version (Windows Only)

pnpm portable

Contributing Your Changes

Before Committing

Code quality checks:

# Rust backend
cargo clippy-all
# Frontend
pnpm lint

Code formatting:

# Rust backend
cargo fmt
# Frontend
pnpm format

Signing your commit

Signed commits are required to verify authorship and ensure your contributions can be merged. Reference signing-commits here.

Submitting Your Changes

1. Fork the repository.

2. Create a new branch for your feature or bug fix.

3. Commit your changes with clear messages and make sure it's signed.

4. Push your branch and submit a pull request.

We appreciate your contributions and look forward to your participation!