CONTRIBUTING

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

Development Setup

Before you start contributing to the project, you need to set up your development environment. Here are the steps you need to follow:

Prerequisites

Install Rust and Node.js: Our project requires both Rust and Node.js. Please follow the instructions provided here to install them on your system.

Setup for Windows Users

If you're a Windows user, you may need to perform some additional steps:

Make sure to add Rust and Node.js to your system's PATH. This is usually done during the installation process, but you can verify and manually add them if necessary.
The gnu patch tool should be installed

Install Node.js Packages

After installing Rust and Node.js, install the necessary Node.js packages:

pnpm i

Download the Clash Binary

You have two options for downloading the clash binary:

Automatically download it via the provided script:

pnpm run check
# Use '--force' to force update to the latest version
# pnpm run check --force

Manually download it from the Clash Meta release. After downloading, rename the binary according to the Tauri configuration.

Run the Development Server

To run the development server, use the following command:

pnpm dev
# If an app instance already exists, use a different command
pnpm dev:diff

Build the Project

If you want to build the project, use:

pnpm build

Contributing Your Changes

Once you have made your changes:

Fork the repository.
Create a new branch for your feature or bug fix.
Commit your changes with clear and concise commit messages.
Push your branch to your fork and submit a pull request to our repository.

We appreciate your contributions and look forward to your active participation in our project!

2.1 KiB Raw Blame History