Skip to content

Commit 536caa7

Browse files
committed
更新文档
1 parent 4237e82 commit 536caa7

File tree

6 files changed

+41
-27
lines changed

6 files changed

+41
-27
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
! -------------------------------------------------------------
44
! Doc Type : Markdown
55
! Doc Name : README.md
6-
! Doc Authors : Aoran Zeng <[email protected]>
6+
! Doc Authors : 曾奥然 <[email protected]>
77
! Contributors : Mikachu2333 <[email protected]>
88
! |
99
! Created On : <2023-12-28>
10-
! Last Modified : <2025-08-17>
10+
! Last Modified : <2025-08-22>
1111
! ---------------------------------------------------------- -->
1212

1313
<div align="center">
@@ -67,7 +67,7 @@
6767
---
6868

6969
> [!IMPORTANT]
70-
> **`chsrc` 可换源 65+ 目标。每个人仅仅贡献和维护自己熟悉的部分,回报是得到其他所有领域专家的帮助。** [欢迎成为 recipe 维护者](https://github.com/RubyMetric/chsrc/issues/130)
70+
> **`chsrc` 可换源 65+ 目标。每个人仅仅贡献和维护自己熟悉的部分,回报是得到其他所有领域专家的帮助。** [欢迎成为 recipe 维护者](https://github.com/RubyMetric/chsrc/issues/275)
7171
7272
<br>
7373

doc/01-开发与构建.md

Lines changed: 4 additions & 4 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 : Aoran Zeng <[email protected]>
7-
! Contributors : Nul None <[email protected]>
6+
! Doc Authors : 曾奥然 <[email protected]>
7+
! Contributors : Nul None <[email protected]>
88
! |
99
! Created On : <2024-12-27>
10-
! Last Modified : <2025-07-21>
10+
! Last Modified : <2025-08-22>
1111
! ---------------------------------------------------------- -->
1212

1313
# 开发 chsrc
@@ -53,7 +53,7 @@ git clone https://gitee.com/RubyMetric/chsrc.git -b dev
5353
3. **`RELEASE mode`**
5454
4. **`CI-RELEASE mode`**
5555

56-
第四种只在 GitHub Actions 使用,一般只需要前三者;而在开发时你仅需要前两者;如果不需要 Debug,仅仅第一个 **DEV mode** 就够了
56+
开发时只需要前两种模式;第四种模式只在 GitHub Actions 使用。
5757

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

doc/02-提交与贡献.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
! -------------------------------------------------------------
44
! Doc Type : Markdown
55
! Doc Name : 02-提交与贡献.md
6-
! Doc Authors : Aoran Zeng <[email protected]>
7-
! Contributors : Nul None <[email protected]>
6+
! Doc Authors : 曾奥然 <[email protected]>
7+
! Contributors : Nul None <[email protected]>
88
! |
99
! Created On : <2024-12-13>
10-
! Last Modified : <2025-07-21>
10+
! Last Modified : <2025-08-22>
1111
! ---------------------------------------------------------- -->
1212

1313
# 贡献说明
@@ -22,6 +22,8 @@
2222

2323
## 提交与审阅
2424

25+
当你提交 PR 的时候,一定要将 PR 指定 chsrc 原仓库的 dev 分支。
26+
2527
### 一个简单的 Bug
2628

2729
一个简单的 Bug fix,有写权限的维护者可以直接推送到主仓库的 `dev` 分支
@@ -34,15 +36,14 @@
3436

3537
(1)
3638

37-
1. **如果你是 recipe Chef,则你完全负责这个 recipe,如果你拥有写权限,你可以直接推送代码到 `dev` 分支**
38-
2. 如果你是 recipe Cook,则你需要参考 recipe 中记录的 Cook 信息,如果只有你一个人,且你拥有写权限,你可以直接推送代码。如果有多人,则需要提一个 issue,介绍方案,然后 @ 所有 Cook 来 review
39+
**如果你是 recipe Chef,则你完全负责这个 recipe,如果你拥有写权限,你可以直接推送代码到 `dev` 分支**
3940

4041
---
4142

4243
(2)
4344

44-
1. 需要先搜索你修改的部分涉及到的 recipe,然后提 issue @ 所有相关的 recipe Cook 来 review
45-
2. 如果涉及了所有 recipe,则 @ framework Cook,而无需把所有 recipe 的 Cook 都喊过来,但是如果觉得有必要,可以 @ 任意你觉得有能力 review 和能给出建议的人来 review
45+
1. 需要先搜索你修改的部分涉及到的 recipe,然后提 issue @ 所有相关的 recipe Chef 来 review
46+
2. 如果涉及了所有 recipe,则 @ framework Chef,而无需把所有 recipe 的 Chef 都喊过来,但是如果觉得有必要,可以 @ 任意你觉得有能力 review 和能给出建议的人来 review
4647

4748
<br>
4849

doc/10-如何编写recipe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
! -------------------------------------------------------------
44
! Doc Type : Markdown
55
! Doc Name : 10-如何编写recipe.md
6-
! Doc Authors : Aoran Zeng <[email protected]>
7-
! Contributors : Nul None <[email protected]>
6+
! Doc Authors : 曾奥然 <[email protected]>
7+
! Contributors : Nul None <[email protected]>
88
! |
99
! Created On : <2024-08-19>
10-
! Last Modified : <2025-08-17>
10+
! Last Modified : <2025-08-22>
1111
! ---------------------------------------------------------- -->
1212

1313
# Write A Recipe Even If You Don't Know C

doc/11-如何设置换源链接与测速链接.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
! -------------------------------------------------------------
44
! Doc Type : Markdown
55
! Doc Name : 11-如何设置换源链接与测速链接.md
6-
! Doc Authors : Aoran Zeng <[email protected]>
7-
! Contributors : Nul None <[email protected]>
6+
! Doc Authors : 曾奥然 <[email protected]>
7+
! Contributors : Nul None <[email protected]>
88
! |
99
! Created On : <2025-08-11>
1010
! Last Modified : <2025-08-11>

doc/50-协作者与维护者.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,34 @@
1-
# 协作者与维护者
2-
3-
作为该语言的资深用户、该软件的专家、镜像站维护人员等,你总是对镜像站和源的可用状态拥有一手信息,我们需要你的帮助。如果想要达到最理想的维护状态,每一个 recipe 都需要有专人长时间维护。所以我们在这个文件记录的是愿意**长期**维护的人,如果是一次性提交代码,只需要在对应 recipe 的文件标头中记录即可。
1+
<!-- -----------------------------------------------------------
2+
! SPDX-License-Identifier: GFDL-1.3-or-later
3+
! -------------------------------------------------------------
4+
! Doc Type : Markdown
5+
! Doc Name : 50-协作者与维护者.md
6+
! Doc Authors : 曾奥然 <[email protected]>
7+
! Contributors : Nul None <[email protected]>
8+
! |
9+
! Created On : <2024-12-06>
10+
! Last Modified : <2025-08-22>
11+
! ---------------------------------------------------------- -->
412

5-
**我们的代码里使用了 recipe (某个菜的烹饪方法) 这个词,因而整个项目便和 "饮食" 有关,比如 `menu`: 汇集了所有的 target 的菜单。因此,我们的维护者身份依然使用了这个惯例:**
13+
# 协作者与维护者
614

7-
一个 recipe 的协作者可分为:
15+
想要达到最理想的维护状态,每一个 recipe 都需要有专人长时间维护。**我们的代码里使用了 recipe (某个菜的烹饪方法) 这个词,因而整个项目便和 "饮食" 有关,比如 `menu`: 汇集了所有的 target 的菜单。因此,我们的维护者和贡献者身份依然使用了这个惯例:**
816

917
1. **Chef**
1018

11-
主厨: 对一个 recipe 完全负责,有写权限时可以直接推代码
19+
品控 (主厨): 对一个 recipe 完全负责,有写权限时可以直接推代码
1220

1321
**目前项目的发展阶段还处于 *外行实现内行* 的情况,比如 Homebrew recipe,实现者根本不是 Homebrew 的真实用户,只是根据各种文档来实现,然后等待用户反馈。所以这里当前的实现者最多只能是 Cook,无法承担 Chef 的责任**
1422

1523
2. **Cook**
1624

17-
副厨:实现和持续维护 recipe,需要和 Chef 一起 review 代码。可参考 [03-CONTRIBUTING.md](./03-CONTRIBUTING.md) 了解项目是如何进行提交和审阅代码的
25+
掌勺:一个 recipe 的主要作者
26+
27+
3. **Saucier**
28+
29+
调味:一个 recipe 的次要贡献者 (除主要作者外的其他人)
1830

1931
<br>
2032

21-
**项目采用申请制,Chef 仅有1人,Cook 可有多人。请提交 PULL REQUEST 在对应的 recipe 文件中添加自己,并在 [issue #130](https://github.com/RubyMetric/chsrc/issues/130) 留言。**
33+
**Chef 采用申请制,每个 recipe 仅有1人,请提交 PULL REQUEST 在对应的 recipe 文件中添加自己,并在 [issue #275
34+
](https://github.com/RubyMetric/chsrc/issues/275) 留言。**

0 commit comments

Comments
 (0)