diff --git a/README.md b/README.md index 8aa838d..a4eb3e6 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@ ! ------------------------------------------------------------- ! Doc Type : Markdown ! Doc Name : README.md - ! Doc Authors : Aoran Zeng + ! Doc Authors : 曾奥然 ! Contributors : Mikachu2333 ! | ! Created On : <2023-12-28> - ! Last Modified : <2025-08-17> + ! Last Modified : <2025-08-22> ! ---------------------------------------------------------- -->
@@ -67,7 +67,7 @@ --- > [!IMPORTANT] -> **`chsrc` 可换源 65+ 目标。每个人仅仅贡献和维护自己熟悉的部分，回报是得到其他所有领域专家的帮助。** [欢迎成为 recipe 维护者](https://github.com/RubyMetric/chsrc/issues/130) +> **`chsrc` 可换源 65+ 目标。每个人仅仅贡献和维护自己熟悉的部分，回报是得到其他所有领域专家的帮助。** [欢迎成为 recipe 维护者](https://github.com/RubyMetric/chsrc/issues/275)
diff --git a/doc/01-开发与构建.md b/doc/01-开发与构建.md index bbea6c8..27a1422 100644 --- a/doc/01-开发与构建.md +++ b/doc/01-开发与构建.md @@ -3,11 +3,11 @@ ! ------------------------------------------------------------- ! Doc Type : Markdown ! Doc Name : 01-开发与构建.md - ! Doc Authors : Aoran Zeng - ! Contributors : Nul None + ! Doc Authors : 曾奥然 + ! Contributors : Nul None ! | ! Created On : <2024-12-27> - ! Last Modified : <2025-07-21> + ! Last Modified : <2025-08-22> ! ---------------------------------------------------------- --> # 开发 chsrc @@ -53,7 +53,7 @@ git clone https://gitee.com/RubyMetric/chsrc.git -b dev 3. **`RELEASE mode`** 4. **`CI-RELEASE mode`** -第四种只在 GitHub Actions 使用，一般只需要前三者；而在开发时你仅需要前两者；如果不需要 Debug，仅仅第一个 **DEV mode** 就够了。 +开发时只需要前两种模式；第四种模式只在 GitHub Actions 使用。 **如果你使用 `just`，可以在 VS Code 中获得更好的体验，按 `Ctrl-Shift-B` 直接使用 DEV mode 构建** diff --git a/doc/02-提交与贡献.md b/doc/02-提交与贡献.md index eefc4fc..288e26b 100644 --- a/doc/02-提交与贡献.md +++ b/doc/02-提交与贡献.md @@ -3,11 +3,11 @@ ! ------------------------------------------------------------- ! Doc Type : Markdown ! Doc Name : 02-提交与贡献.md - ! Doc Authors : Aoran Zeng - ! Contributors : Nul None + ! Doc Authors : 曾奥然 + ! Contributors : Nul None ! | ! Created On : <2024-12-13> - ! Last Modified : <2025-07-21> + ! Last Modified : <2025-08-22> ! ---------------------------------------------------------- --> # 贡献说明 @@ -22,6 +22,8 @@ ## 提交与审阅 +当你提交 PR 的时候，一定要将 PR 指定 chsrc 原仓库的 dev 分支。 + ### 一个简单的 Bug 一个简单的 Bug fix，有写权限的维护者可以直接推送到主仓库的 `dev` 分支 @@ -34,15 +36,14 @@ （1） -1. **如果你是 recipe Chef，则你完全负责这个 recipe，如果你拥有写权限，你可以直接推送代码到 `dev` 分支** -2. 如果你是 recipe Cook，则你需要参考 recipe 中记录的 Cook 信息，如果只有你一个人，且你拥有写权限，你可以直接推送代码。如果有多人，则需要提一个 issue，介绍方案，然后 @ 所有 Cook 来 review +**如果你是 recipe Chef，则你完全负责这个 recipe，如果你拥有写权限，你可以直接推送代码到 `dev` 分支** --- （2） -1. 需要先搜索你修改的部分涉及到的 recipe，然后提 issue @ 所有相关的 recipe Cook 来 review -2. 如果涉及了所有 recipe，则 @ framework Cook，而无需把所有 recipe 的 Cook 都喊过来，但是如果觉得有必要，可以 @ 任意你觉得有能力 review 和能给出建议的人来 review +1. 需要先搜索你修改的部分涉及到的 recipe，然后提 issue @ 所有相关的 recipe Chef 来 review +2. 如果涉及了所有 recipe，则 @ framework Chef，而无需把所有 recipe 的 Chef 都喊过来，但是如果觉得有必要，可以 @ 任意你觉得有能力 review 和能给出建议的人来 review
diff --git a/doc/10-如何编写recipe.md b/doc/10-如何编写recipe.md index 518af2e..c4f457f 100644 --- a/doc/10-如何编写recipe.md +++ b/doc/10-如何编写recipe.md @@ -3,11 +3,11 @@ ! ------------------------------------------------------------- ! Doc Type : Markdown ! Doc Name : 10-如何编写recipe.md - ! Doc Authors : Aoran Zeng - ! Contributors : Nul None + ! Doc Authors : 曾奥然 + ! Contributors : Nul None ! | ! Created On : <2024-08-19> - ! Last Modified : <2025-08-17> + ! Last Modified : <2025-08-22> ! ---------------------------------------------------------- --> # Write A Recipe Even If You Don't Know C diff --git a/doc/11-如何设置换源链接与测速链接.md b/doc/11-如何设置换源链接与测速链接.md index b38fbc5..f50ef68 100644 --- a/doc/11-如何设置换源链接与测速链接.md +++ b/doc/11-如何设置换源链接与测速链接.md @@ -3,8 +3,8 @@ ! ------------------------------------------------------------- ! Doc Type : Markdown ! Doc Name : 11-如何设置换源链接与测速链接.md - ! Doc Authors : Aoran Zeng - ! Contributors : Nul None + ! Doc Authors : 曾奥然 + ! Contributors : Nul None ! | ! Created On : <2025-08-11> ! Last Modified : <2025-08-11> diff --git a/doc/50-协作者与维护者.md b/doc/50-协作者与维护者.md index 9cd46a4..861ffad 100644 --- a/doc/50-协作者与维护者.md +++ b/doc/50-协作者与维护者.md @@ -1,21 +1,34 @@ + + # 协作者与维护者 -作为该语言的资深用户、该软件的专家、镜像站维护人员等，你总是对镜像站和源的可用状态拥有一手信息，我们需要你的帮助。如果想要达到最理想的维护状态，每一个 recipe 都需要有专人长时间维护。所以我们在这个文件记录的是愿意**长期**维护的人，如果是一次性提交代码，只需要在对应 recipe 的文件标头中记录即可。 - -**我们的代码里使用了 recipe (某个菜的烹饪方法) 这个词，因而整个项目便和 "饮食" 有关，比如 `menu`: 汇集了所有的 target 的菜单。因此，我们的维护者身份依然使用了这个惯例：** - -一个 recipe 的协作者可分为： +想要达到最理想的维护状态，每一个 recipe 都需要有专人长时间维护。**我们的代码里使用了 recipe (某个菜的烹饪方法) 这个词，因而整个项目便和 "饮食" 有关，比如 `menu`: 汇集了所有的 target 的菜单。因此，我们的维护者和贡献者身份依然使用了这个惯例：** 1. **Chef** - 主厨: 对一个 recipe 完全负责，有写权限时可以直接推代码 + 品控 (主厨): 对一个 recipe 完全负责，有写权限时可以直接推代码 **目前项目的发展阶段还处于 *外行实现内行* 的情况，比如 Homebrew recipe，实现者根本不是 Homebrew 的真实用户，只是根据各种文档来实现，然后等待用户反馈。所以这里当前的实现者最多只能是 Cook，无法承担 Chef 的责任** 2. **Cook** - 副厨：实现和持续维护 recipe，需要和 Chef 一起 review 代码。可参考 [03-CONTRIBUTING.md](./03-CONTRIBUTING.md) 了解项目是如何进行提交和审阅代码的 + 掌勺：一个 recipe 的主要作者 + +3. **Saucier** + + 调味：一个 recipe 的次要贡献者 (除主要作者外的其他人)
-**项目采用申请制，Chef 仅有1人，Cook 可有多人。请提交 PULL REQUEST 在对应的 recipe 文件中添加自己，并在 [issue #130](https://github.com/RubyMetric/chsrc/issues/130) 留言。** +**Chef 采用申请制，每个 recipe 仅有1人，请提交 PULL REQUEST 在对应的 recipe 文件中添加自己，并在 [issue #275 +](https://github.com/RubyMetric/chsrc/issues/275) 留言。**