Skip to content

Latest commit

 

History

History
148 lines (103 loc) · 8.66 KB

CONTRIBUTING.md

File metadata and controls

148 lines (103 loc) · 8.66 KB
Raw

Contributing for Minecraft-Mod-Language-Package

名词解释：

  • 模组翻译文件（下文亦称“翻译”），指本项目 projects/{version}/assets 中的用于提供 Minecraft 模组及本体中文本地化支持的文件（包括且不限于模组本体所提供的 lang，json 文件、手册翻译文件）。
  • 代码文件（下文亦称“代码”），指本项目 src 目录下所有代码文件。
  • 配置文件（下文亦称“配置”），指本项目 config 目录下所有代码文件。
  • 本地化修复文件（下文亦称“修复文件”），包括由 3TUSK 提供的全角标点修复文件，酒石酸菌所制作的生僻字兼容文件。
  • Weblate 翻译平台（下文亦称“Weblate”），是一个高度集成了版本控制功能的 web-based 翻译工具。本项目的 Weblate 由 Phi 部署搭建。
  • Pull Requests（下文亦称“PR”）。

请在贡献前仔细阅读此文档（特别是加粗部分）

目录：

  1. 翻译用语共识
  2. 翻译贡献指南
  3. 代码贡献指南
  4. 配置更改指南
  5. 最后需要注意的

翻译用语共识

  1. “材料+质/制+中心词”的翻译，如“铁质涡轮”“铁制涡轮”，二者皆合理。只需单模组内统一。

翻译贡献指南

在提交翻译之前，我们默认以下几点：

  1. 你已阅读并同意 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议（简体中文）
  2. 你已阅读翻译相关注意事项：Minecraft 模组简体中文翻译规范与指南（十分重要）

有关翻译的说明：

  • 不要望文生义，有些看起来十分离谱的东西可能是正确的。
  • 尽量做到边开游戏边翻译。
  • 本项目对机翻、生硬翻译并不友好，还请在提交具有这些特征的文件时深思熟虑。

有关提交的说明：

  • 请确保提交的语言文件名称大小写正确，一般情况下语言文件名称应为小写。
  • 提交翻译文件时，请一并提交/更新英文原文。
  • 若只提交英文原文，请一并提交空白翻译文件。
    • 1.12 空白翻译文件为无内容的文件
    • 1.16、1.18 空白翻译文件为只包含左右花括号即{}的文件，例子
  • 如果上传的文件中包含_非文本文件_（如.ttf等字体文件，.jpg等图片），有可能需要修改Packer配置。
    • 如果这些文件放置在font/textures中，一般不用修改配置；默认已经对这两处进行了特殊处理。
    • 当然，如果实在弄不清楚怎么改，也可以让我们代劳。
  • 如果涉及到Packer的文件检索模式，请参照这里

有关审查（Review）的说明：

  • 无论是哪种提交方式，都需要在审查通过后才会推送至本项目。
  • 你愿意等待长时间的审查（极端情况下可能长达数月）。
  • 你能够接受因翻译质量问题而提出的批评，并在收到建议后愿意与批评者讨论是否接受更改。

为本项目贡献翻译有以下两种方法：

Weblate

  • Weblate 自 2022 年 4 月起暂停新用户注册。
  • 普通用户不能直接点击“保存”按钮提交翻译，只能点击“建议”按钮。
  • Weblate 中做出的更改在被审核通过后会被同步到本仓库。
  • 善用 Weblate 的词汇表，可规范翻译及提高翻译效率。

GitHub PR

  • 默认你对 Git、GitHub 已经有了一定的了解，并且懂得使用 PR。
  • 请提交 PR 至 main 分支。
  • 若要提交多个模组的翻译，请尽量分多个 PR 提交。
  • PR 标题需简洁明了，格式应为 {模组英文全名} {简述}。
    • ✔️Tinkers Construct 翻译提交
    • ✔️Tinkers Construct 更新至 1.18.2
    • ❌TiC3 翻译更新（未使用全名）
    • ❌匠魂翻译更新（未包含英文名）
  • 请确保提交文件的路径是正确的（例子）。
    • 如果是 1.12 翻译，应该是：projects/1.12.2/assets/{CurseForge 项目名称}/{ModID}/lang/zh_cn.lang
    • 如果是 1.16 及以上的翻译，应该是：projects/{版本}/assets/{CurseForge 项目名称}/{ModID}/lang/zh_cn.json
  • 未完工的翻译仍可提交 PR，可以先设置为 Draft。
  • 善用相关词语填写 PR 信息或 Commit 信息，如提交、更新/修改、删除。
  • 提交 PR 后，后续跟进消息会以邮件的方式通知，请留意注册邮箱（有可能会被处理为垃圾邮件）。
  • 请勿对本地化修复文件做出任何改动。
  • 请勿在提交翻译的 Commit 中同时更改配置以及代码，除非你明白且愿意承担所造成的相关后果。

提交文件路径的例子

此例子演示的是 1.16 json 文件路径，而 1.12 lang 文件路径也十分类似。

版本：提交的翻译所属模组适用于 Forge 下的 Minecraft 1.16，则选用 {版本} 为 1.16。

若提交的翻译所属模组适用于 Fabric 客户端，选用带有 fabric 字样的文件夹。

CurseForge 项目名称：Tinkers Construct 的 CurseForge 页面地址为 https://www.curseforge.com/minecraft/mc-mods/tinkers-construct，则 {CurseForge 项目名称} 为 mc-mods/ 后面的内容（或 mc-mods/ 和 下一个 / 之间的内容），即 tinkers-construct。

ModID：Tinkers Construct 英文原文的路径为 assets/tconstruct/lang/en_us.json，则 {ModId} 为 assets/ 和 /lang 之间的内容，即 tconstruct。

最终你要提交翻译文件的路径为 projects/1.16/assets/tinkers-construct/tconstruct/lang/zh_cn.json。en_us.json 文件在同级文件夹下。

代码贡献指南

  • 我们默认你已了解 C#、GitHub Actions 以及相关计算机的基本知识。
  • 贡献代码有着更加严格的审查，请不要发无意义的、影响本项目运作的 PR（例：SPAM）。
  • 在提交前，你已测试过你的代码能够正常的运行。
  • 请简要描述提交的代码的作用。

配置更改指南

这里只列出了部分修改可能较大的文件

config/spider/config.json

Spider目前暂时停用，以下事项仅作参考。

  • "version"：游戏版本，请勿修改
  • "spider_conf"：爬虫相关设置
  • "base_mod_count"：默认爬取模组的数量
  • "black_list"：模组黑名单，元素为 String 类型，内容为 CurseForge 的 Project ID
  • "white_list"：同上，为模组白名单

注意事项：

  • 请不要随意删除黑名单模组，这些模组在这里是有原因的。
  • 请不要在未经同意的情况下修改默认爬取数量。

config/packer.json

该文件内放置了所有正在维护的版本的打包配置。 最好不要随意删去内容，除非你知道它曾经是干什么的，现在为什么不需要了。 加入内容相对而言宽松一些，但最好还是说明理由。

下面没有提到的一般都不适合改动；如果需要，最好说明理由。

主要的更改场景：

  • 增加新翻译版本
    • 需要将所有项填写一遍，同时需要更新.github/workflows/packer.yml、.github/workflows/pr-packer.yml、.github\boring-cyborg.yml，以及CFPABot等相关服务。没有规划最好不要乱动。
  • 处理非文本文件
    1. 如果该文件所在的namespace（asset-domain下方的一级）对任何模组都不会有文本文件（如font\），将该namespace加入对应版本的noProcessNamespace中
    2. 否则，将该模组的curseforge项目名或asset-domain中的一个（具体选哪一个看具体情况）加入modNameBlackList或domainBlackList（对应）， 并将所有受影响的文件的相对位置加入additionalContents（格式可以仿照已有的文件）
  • 添加非标准位置（在assets/以外）的文件
    • 直接加入additionalContents

最后需要注意的

若有不明白的地方，可前往 QQ 群（630943368，较为活跃）或 Discord 提问。

本项目的每个贡献者都是理应感谢的人。