Skip to content

Commit c91c65e

Browse files
committed
更新文档
1 parent f1f65f3 commit c91c65e

File tree

3 files changed

+15
-6
lines changed

3 files changed

+15
-6
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
# 向 chsrc 项目贡献
1+
# `chsrc` 项目贡献
22

3-
请阅读 [./doc/02-提交与贡献.md](./doc/02-提交与贡献.md)
3+
请阅读 [./doc/README.md](./doc/README.md)

doc/01-开发与构建.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
! -------------------------------------------------------------
44
! Doc Type : Markdown
55
! Doc Name : 01-开发与构建.md
6-
! Doc Authors : 曾奥然 <ccmywish@qq.com>
7-
! Contributors : Mikachu2333 <mikachu.23333@zohomail.com>
6+
! Doc Authors : @ccmywish
7+
! Contributors : @Mikachu2333
88
! |
99
! Created On : <2024-12-27>
10-
! Last Modified : <2025-10-11>
10+
! Last Modified : <2026-03-25>
1111
! ---------------------------------------------------------- -->
1212

1313
# 开发 chsrc
@@ -57,6 +57,8 @@ git clone https://gitee.com/RubyMetric/chsrc.git -b dev
5757

5858
**如果你使用 `just`,可以在 VS Code 中获得更好的体验,按 `Ctrl-Shift-B` 直接使用 DEV mode 构建**
5959

60+
**注意: `DEBUG` 模式下, 执行任意一个 `recipe` 的任意操作,会额外检查所有 `_prelude()` 是否能正常工作,如: `./chsrc-debug ls <recipe>`**
61+
6062
```bash
6163
just (b) # 在Windows上默认使用 gcc 编译,在macOS上默认使用 clang 编译,在其他系统上默认使用 cc 编译
6264
just CC=clang # 使用 clang 编译

doc/02-提交与贡献.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ chef_register_contributor ("@ID: 你的GitHub/Gitee用户名或任意不与其
5050
chef_set_sources_last_updated (this, "YYYY-MM-DD");
5151
```
5252
53-
3. **将自己加入 `sauciers`**(次要贡献者列表,将计数加一并附上自己的 GitHub handle):
53+
3. **将自己加入 `sauciers`**(次要贡献者列表,将计数加一并添加自己的 `@ID`):
5454
```c
5555
// 原来是 0 个 saucier:
5656
chef_set_sauciers (this, 0);
@@ -63,6 +63,13 @@ chef_register_contributor ("@ID: 你的GitHub/Gitee用户名或任意不与其
6363
chef_set_sauciers (this, 2, "@Someone", "@你刚注册的ID");
6464
```
6565

66+
4. **验证上述信息正确**
67+
68+
```sh
69+
# 应当能看到你的信息
70+
./chsrc ls <recipe>
71+
```
72+
6673
<br>
6774

6875

0 commit comments

Comments
 (0)