Skip to content

Commit 267e642

Browse files
CactusstudentdovisutuSlimeSB
authored
文档更新后续 & Modrinth 路径支持 (#4276)
* 更改文件路径以适应新的更改 * Change the direct * 更改对 `Modrinth 项目名称` 的简述 * Clean F3 模组路径修改 * Change Direction * Change direction * 更改路径 * 小更改 * 对仓库结构描述进行更新 * 更新贡献方针:新增公示规则 * 对原文进行更改,修改排版 * L174 删多余空格 * Pack-Doc 全文加空格 * 更新贡献方针 * Update CONTRIBUTING.md Co-authored-by: dovisutu <[email protected]> * 为Wiktionary添加访问可能受限的注释 * Update CONTRIBUTING.md Co-authored-by: dovisutu <[email protected]> * Apply suggestions from code review Co-authored-by: dovisutu <[email protected]> * 更改公示规则3,增加句号,调整语序 * Apply suggestions from code review Co-authored-by: SlimeSB <[email protected]> --------- Co-authored-by: dovisutu <[email protected]> Co-authored-by: SlimeSB <[email protected]>
1 parent d09b868 commit 267e642

File tree

39 files changed

+103
-90
lines changed

39 files changed

+103
-90
lines changed

CONTRIBUTING.md

Lines changed: 41 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
- [审查人](#审查人)
1818
- [PR 作者](#pr-作者)
1919
- [搁置规则](#搁置规则)
20+
- [公示规则](#公示规则)
2021
- [提示](#提示)
2122
- [代码贡献指南](#代码贡献指南)
2223
- [配置更改指南](#配置更改指南)
@@ -38,16 +39,18 @@ Minecraft-Mod-Language-Package
3839
│  │ └─lang ----------------- // 语言文件文件夹
3940
│  │ ├─en_us.json --------- // English (United States) 语言文件
4041
│  │ └─zh_cn.json --------- // 中文 (简体) 语言文件
42+
│ ├─(Modrinth 项目名称)------- // 见下
43+
│  │ └─(命名空间) ------------- // 见下
44+
│  │ └─lang ----------------- // 语言文件文件夹
45+
│  │ ├─en_us.json --------- // English (United States) 语言文件
46+
│  │ └─zh_cn.json --------- // 中文 (简体) 语言文件
4147
│  ├─minecraft
4248
│  │ └─minecraft -------------- // Minecraft 原版使用的命名空间
4349
│  │ ├─font
4450
│  │ │ └─glyph_sizes.bin ---- // 全角标点修复文件
4551
│  │ └─textures
4652
│  │ └─font --------------- // 全角标点修复文件
47-
│  ├─1UNKNOWN ----------------- // 存放不在 CurseForge 和 Modrinth 上发布的模组
48-
│  │ └─(命名空间)
49-
│  │ └─lang
50-
│ └─0-modrinth-mod ----------- // 存放仅发布在 Modrinth 上的模组
53+
│  └─1UNKNOWN ----------------- // 存放不在 CurseForge 和 Modrinth 上发布的模组
5154
│  └─(命名空间)
5255
│  └─lang
5356
└─src --------------- // 各种自动化工具的源码
@@ -62,35 +65,39 @@ Minecraft-Mod-Language-Package
6265

6366
**命名空间(Namespace)**:以匠魂为例,用压缩软件打开模组文件(JAR 格式),它的 en_us.json 的路径为 `assets/tconstruct/lang/en_us.json`,则 `{命名空间}``assets/``/lang` 之间的内容,即 `tconstruct`。一个模组可能有多个命名空间。命名空间介绍见 [Minecraft Wiki](https://zh.minecraft.wiki/w/%E5%91%BD%E5%90%8D%E7%A9%BA%E9%97%B4ID?variant=zh-cn#%E5%91%BD%E5%90%8D%E7%A9%BA%E9%97%B4)
6467

68+
**Modrinth 项目名称**:以 Modrinth 独占模组 Clean F3 为例,它的 Modrinth 页面地址是 `https://modrinth.com/mod/clean-f3`,则在 `mod/` 后的内容 `clean-f3``{Modrinth 项目名称}`**主体**部分,而为了与 Curseforge 上发布的模组作以区分,所有仅在 Modrinth 上发布的模组,在其之前需要添加 `modrinth-` 作为区分。综上,它的 `{Modrinth 项目名称}``modrinth-clean-f3`
69+
6570
仓库中“命名空间”文件夹下的目录结构与[资源包](https://zh.minecraft.wiki/w/%E8%B5%84%E6%BA%90%E5%8C%85)的相应结构相同,其他可用资源包加载的本地化文件亦可接收。
6671

6772
projects 文件夹下只标出模组所属的大版本号,其中的模组翻译文件应满足以下优先级:
6873

69-
1. 模组活跃更新的 Minecraft 版本优先。若所有小版本都活跃更新,则
70-
2. Minecraft 版本高者优先。
74+
1. 模组活跃更新的 Minecraft 版本优先。
75+
2. 若所有小版本都活跃更新,则 Minecraft 版本高者优先。
76+
7177

7278
* 例:Minecraft 版本 1.19.2 与 1.19.4 均属同一大版本号 1.19 下的子版本。
7379
若某一模组在两个版本上的开发均活跃,由于 1.19.4 的版本号更高,因此优先考虑该模组在 1.19.4 下的译名标准化情况与适配情况。
7480
这一优先级不会影响到模组在其他大版本下(如 1.18、1.12 等)的分支。
7581

7682
## 翻译用语共识
7783

78-
1. “材料+质/制+中心词”的翻译,如“铁质涡轮”“铁制涡轮”,二者皆合理。只需单模组内统一。
79-
2. 关于“木制品名称”的翻译,可参考 <https://github.com/CFPAOrg/Minecraft-Mod-Language-Package/pull/2715#discussion_r1056901664> 中的解决方法。
84+
1. “材料 + 质/制 + 中心词”的翻译,如“铁质涡轮”或“铁制涡轮”,二者皆合理。只需单模组内统一。
85+
2. 关于“木制品名称”的翻译,可参考 #4525 的解决方法。
86+
8087

8188
## 翻译贡献方针
8289

83-
以下内容只针对对 [projects](./projects) 文件夹下的贡献。
90+
以下内容只针对 [projects](./projects) 文件夹下的贡献。
8491

8592
### 总则
8693

8794
- 翻译**必须**符合 [Minecraft 模组简体中文翻译规范与指南](https://cfpa.site/TransRules/)的规定。
88-
- **拒绝**接收机器翻译(含生成式AI)、生硬翻译。
95+
- **拒绝**接收机器翻译(含生成式 AI)、生硬翻译。
8996
- 翻译**必须**在审查后才能进入仓库。
9097

9198
### Pull Request 相关规定
9299

93-
可查看[视频教程](https://www.bilibili.com/video/BV1Ph4y1R7M8/)(已过时)[文字教程](https://github.com/CFPAOrg/Minecraft-Mod-Language-Package/wiki/%E4%BD%BF%E7%94%A8-GitHub-%E6%8F%90%E4%BA%A4%E7%BF%BB%E8%AF%91)来学习。注意,视频或文字教程都只介绍了 Pull Request 的使用方法,贡献方针仍需阅读。
100+
可查看[视频教程](https://www.bilibili.com/video/BV1yqgge9EVK/)[文字教程](https://github.com/CFPAOrg/Minecraft-Mod-Language-Package/wiki/%E4%BD%BF%E7%94%A8-GitHub-%E6%8F%90%E4%BA%A4%E7%BF%BB%E8%AF%91)来学习。注意,视频或文字教程都只介绍了 Pull Request 的使用方法,贡献方针仍需阅读。同时,我们默认翻译贡献者已拥有一定的 Github 基础知识
94101

95102
视频或文字教程中与翻译贡献方针不同的地方,以本方针为准。
96103

@@ -134,9 +141,9 @@ projects 文件夹下只标出模组所属的大版本号,其中的模组翻
134141
#### 审查人
135142

136143
- 任何人都能利用 GitHub 提供的[相关功能](https://docs.github.com/zh/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)来审查 PR 中翻译。所有参与审查的用户即为审查人。
137-
- [CFPA团队](https://github.com/CFPAOrg)的成员(Member)和[仓库](https://github.com/CFPAOrg/Minecraft-Mod-Language-Package)的协作者(Collaborator)是具有团队官方性质的审查人。
144+
- [CFPA团队](https://github.com/CFPAOrg) 的成员(Member)和[仓库](https://github.com/CFPAOrg/Minecraft-Mod-Language-Package)的协作者(Collaborator)是具有团队官方性质的审查人。
138145
- 至少一位具有官方身份的审查人对 PR 给出批准(Approval)审查后,PR 才能合并。
139-
- 审查人在给出批准审查后****给 PR 加上“即将合并”标签,此后需等待大于 24 小时,若等待期间没有新动态则可以合并 PR。
146+
- 审查人在给出批准审查后****给 PR 加上“即将合并”标签,此后需至少等待 24 小时,若等待期间没有新动态则可以合并 PR。
140147
- “动态”包括但不限于 PR 作者发送提交(Commit)、审查人提出意见。
141148

142149
#### PR 作者
@@ -149,21 +156,30 @@ projects 文件夹下只标出模组所属的大版本号,其中的模组翻
149156

150157
### 搁置规则
151158

152-
搁置规则的目的是解决由于 PR 作者迟迟不出面响应审查要求而导致的 PR 积压问题。
159+
搁置规则用于解决由于 PR 作者迟迟不出面响应审查要求而导致的 PR 积压问题。
153160

154161
1. 若 PR 中存在未作者未响应的审查超过 7 天,审查人有权提及(@)PR 作者,提醒其相应审查意见,然后加上“即将被搁置”标签。
155162
2. 若“即将被搁置”标签存在超过 7 天,PR 作者将被视为无法回应。此时
156-
2.1 若存在要求 PR 作者参与的审查意见,PR 将被加上“即将拒收”标签。1 天后 PR 将被关闭。
157-
2.2 若审查意见都无需 PR 作者参与,PR 将被加上“即将拒收”标签。1 天缓冲期内官方审查人**可以**直接采纳审查意见,并终止计时,转入合并流程。
163+
- 2.1 若存在要求 PR 作者参与的审查意见,PR 将被加上“即将拒收”标签。1 天后 PR 将被关闭。
164+
- 2.2 若审查意见都无需 PR 作者参与,PR 将被加上“即将拒收”标签。1 天缓冲期内官方审查人**可以**直接采纳审查意见,并终止计时,转入合并流程。
158165
3. 在 1、2 所述过程中,若 PR 作者做出了回应,标签将被清除,计时重新从 1 开始。
159166

160167
因搁置而关闭的 PR,PR 作者若想继续更新,可重新打开(Reopen)PR。
161168

169+
### 公示规则
170+
171+
公示规则是为了传播 PR 中某个(些)模组译名或词条的重大更改而设立的,包括但不限于:远古译名的更改,错误译名的更正。
172+
173+
1. 该规则适用于与官方翻译或社区流传度较广的翻译存在**重大差异**,且存在译名或词条更改的 PR。
174+
2. 纯文档或代码贡献 PR **不应**进入公示流程(存在停止支持或重新支持某模组翻译的除外)(例:[#4327](https://github.com/CFPAOrg/Minecraft-Mod-Language-Package/pull/4327)[#4215](https://github.com/CFPAOrg/Minecraft-Mod-Language-Package/pull/4215)
175+
3. 若 PR 在**审查通过后**符合上述规则,则视为该 PR 进入公示流程,同时加上“需要公示”标签,并择日通过如 Bilibili、QQ 群、MC 百科社群等平台发布公示,至发布之日 14 天止视为公示流程结束。此时清除标签并加上“即将合并”标签,转入合并流程。
176+
- 公示时,应当附带:PR 链接、原文、更改内容、更改缘由等,选择性附带图片。
177+
162178
### 提示
163179

164-
- 如果上传的文件中包含**非文本文件**(如`.ttf``.jpg`等),**有可能需要修改 [Packer 配置](config/packer.json)**,否则它们会被打包器排除,不会进入用户使用的资源包。
165-
- 如果这些文件放置在`font``textures`中,一般不用修改配置;默认已经对这两处进行了特殊处理。
166-
- 不同版本的同一模组可通过[自定义文件检索策略](./Packer-Index-Doc.md)同步翻译。
180+
- 如果文件路径不包含语言标记 `zh_cn`,一般需要**修改全局或局域的 Packer 配置**,否则它们会被打包器排除,不会进入用户使用的资源包。具体操作参见[文档](Packer-Doc.md#添加无语言标识的文件)
181+
- 如果这些文件放置在 `font``textures` 中,无需修改配置;默认已经对这两处进行了特殊处理。
182+
- 不同版本的同一模组可通过[自定义文件检索策略](./Packer-Doc.md#检索策略)同步翻译。
167183

168184
## 代码贡献指南
169185

@@ -196,7 +212,7 @@ projects 文件夹下只标出模组所属的大版本号,其中的模组翻
196212

197213
### Packer
198214

199-
路径:`./config/packer/[version].json`如1.12的文件在[1.12.2.json](./config/packer/1.12.2.json)
215+
路径:`./config/packer/[version].json`如 1.12 的文件在 [1.12.2.json](./config/packer/1.12.2.json)
200216

201217
该文件内放置了**所有**正在维护的版本的打包配置。
202218
不要随意*删去*内容,除非你知道它为什么弃用。
@@ -207,18 +223,15 @@ projects 文件夹下只标出模组所属的大版本号,其中的模组翻
207223
主要的更改场景:
208224

209225
- 增加新翻译版本
210-
- 需要将所有项填写一遍,同时需要更新`.github/workflows/packer.yml``.github/workflows/pr-packer.yml``.github\boring-cyborg.yml`,以及 [CFPABot](https://github.com/Cyl18/CFPABot) 等相关服务。没有规划最好不要乱动。
226+
- 需要将所有项填写一遍,同时需要更新 `.github/workflows/packer.yml``.github/workflows/pr-packer.yml``.github\boring-cyborg.yml`,以及 [CFPABot](https://github.com/Cyl18/CFPABot) 等相关服务。没有规划最好不要乱动。
211227
- 更改字符替换表
212-
- 修改`replacementMap`,格式与已有文本一致。Unicode*基础多语种平面(BMP)*以外的字符需要使用**UTF-16代理对**输入,否则可能无法识别
228+
- 修改`characterReplacement`,格式与已有文本一致。对于**基础多语种平面(BMP)**以外的字符,最好用 **UTF-16 代理对**书写
213229
- 同时可能需要修改字体文件。
214230
- 处理非文本文件
215-
1. 如果该文件所在的文件夹与`lang`文件夹同级,且对**任何模组都**不会有文本文件(如font\),将该文件夹加入对应版本的`noProcessNamespace`中。
216-
2. 否则,将该模组的`CurseForge 项目名称``命名空间`中的一个(具体选哪一个看具体情况)加入`modNameBlackList``domainBlackList`,并将**所有**受影响的文件的相对位置加入`additionalContents`
217-
- 添加非标准位置(在`assets/`以外)的文件
218-
- 直接加入`additionalContents`
231+
- 参考 [Packer-Doc](Packer-Doc.md) 对其的描述。
219232
- 停止对某模组的支持
220-
- 把该模组的`CurseForge 项目名称``命名空间`中的加入相应的`modNameBlackList``domainBlackList`(二者取其一)。
233+
- 把该模组的 `CurseForge 项目名称``命名空间`中的加入相应的 `exclusionMods``exclusionDomains`(二者取其一)。
221234

222235
## 联系我们
223236

224-
若有不明白的地方,可[前往 QQ 群](https://jq.qq.com/?_wv=1027&k=5geO1T21)(630943368**较为活跃**)或 [Discord](https://discord.com/invite/SGve5Fn) 提问
237+
若有不明白的地方,可[前往 QQ 群](https://jq.qq.com/?_wv=1027&k=5geO1T21)(630943368

0 commit comments

Comments
 (0)