From b6db209670cd8c3df352d3ebe8e139756734da7e Mon Sep 17 00:00:00 2001 From: Tunglies Date: Tue, 20 May 2025 23:09:25 +0800 Subject: [PATCH] docs: update CONTRIBUTING.md to include guidelines for Rust code formatting and quality checks --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 02c3c9cb..83dd398e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -96,6 +96,24 @@ pnpm portable ## Contributing Your Changes +#### Before commit your changes + +If you changed the rust code, it's recommanded to execute code style formatting and quailty checks. + +1. Code style formatting + +```bash +$ clash-verge-rev: cd src-tauri +$ clash-verge-rev/src-tauri: cargo fmt +``` + +2. Code quailty checks + +```bash +$ clash-verge-rev: pnpm clippy +``` + + Once you have made your changes: 1. Fork the repository.