From c91c65e54d24d4912778ed322b993e645f0f7cc8 Mon Sep 17 00:00:00 2001 From: Aoran Zeng Date: Wed, 25 Mar 2026 11:58:07 +0800 Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 4 ++-- doc/01-开发与构建.md | 8 +++++--- doc/02-提交与贡献.md | 9 ++++++++- 3 files changed, 15 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 01e0ea1c..7825222b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,3 @@ -# 向 chsrc 项目贡献 +# 向 `chsrc` 项目贡献 -请阅读 [./doc/02-提交与贡献.md](./doc/02-提交与贡献.md) +请阅读 [./doc/README.md](./doc/README.md) diff --git a/doc/01-开发与构建.md b/doc/01-开发与构建.md index a2d3b1e0..f22992c0 100644 --- a/doc/01-开发与构建.md +++ b/doc/01-开发与构建.md @@ -3,11 +3,11 @@ ! ------------------------------------------------------------- ! Doc Type : Markdown ! Doc Name : 01-开发与构建.md - ! Doc Authors : 曾奥然 - ! Contributors : Mikachu2333 + ! Doc Authors : @ccmywish + ! Contributors : @Mikachu2333 ! | ! Created On : <2024-12-27> - ! Last Modified : <2025-10-11> + ! Last Modified : <2026-03-25> ! ---------------------------------------------------------- --> # 开发 chsrc @@ -57,6 +57,8 @@ git clone https://gitee.com/RubyMetric/chsrc.git -b dev **如果你使用 `just`，可以在 VS Code 中获得更好的体验，按 `Ctrl-Shift-B` 直接使用 DEV mode 构建** +**注意: `DEBUG` 模式下, 执行任意一个 `recipe` 的任意操作，会额外检查所有 `_prelude()` 是否能正常工作，如: `./chsrc-debug ls `** + ```bash just (b) # 在Windows上默认使用 gcc 编译，在macOS上默认使用 clang 编译，在其他系统上默认使用 cc 编译 just CC=clang # 使用 clang 编译 diff --git a/doc/02-提交与贡献.md b/doc/02-提交与贡献.md index d8d7badc..20d0b534 100644 --- a/doc/02-提交与贡献.md +++ b/doc/02-提交与贡献.md @@ -50,7 +50,7 @@ chef_register_contributor ("@ID: 你的GitHub/Gitee用户名或任意不与其 chef_set_sources_last_updated (this, "YYYY-MM-DD"); ``` -3. **将自己加入 `sauciers`**（次要贡献者列表，将计数加一并附上自己的 GitHub handle）： +3. **将自己加入 `sauciers`**（次要贡献者列表，将计数加一并添加自己的 `@ID`）： ```c // 原来是 0 个 saucier： chef_set_sauciers (this, 0); @@ -63,6 +63,13 @@ chef_register_contributor ("@ID: 你的GitHub/Gitee用户名或任意不与其 chef_set_sauciers (this, 2, "@Someone", "@你刚注册的ID"); ``` +4. **验证上述信息正确** + + ```sh + # 应当能看到你的信息 + ./chsrc ls + ``` +