Skip to content

Latest commit

 

History

History
100 lines (55 loc) · 4.5 KB

CONTRIBUTING.md

File metadata and controls

100 lines (55 loc) · 4.5 KB

Contributing for Minecraft-Mod-Language-Package

模组汉化文件(下文亦称“汉化”),指本项目projects/[version]/assets中的用于提供Minecraft模组及本体中文本地化支持的文件(包括且不限于模组本体所提供的.lang.json文件、帕秋莉手册汉化文件、模组自带手册汉化文件)。

代码文件(下文亦称“代码”),指本项目src目录下所有代码文件。

配置文件(下文亦称“配置”),指本项目config目录下所有代码文件。

本地化修复文件(下文亦称“修复文件”),包括由3TUSK提供的全角标点修复文件,酒石酸菌所制作的生僻字兼容文件。

Weblate汉化平台(下文亦称“Weblate、wl”),是一个高度集成了版本控制功能的web-based翻译工具。本项目的Weblate由 Phi部署搭建。

请在贡献前仔细阅读该贡献文档(特别是加粗部分

目录:

  1. 汉化贡献指南
  2. 代码贡献指南
  3. 配置文件更改指南
  4. 问题反馈
  5. 最后需要注意的

汉化贡献指南

在提交汉化之前,我们默认以下几点:

  1. 您已阅读并同意知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议简体中文

  2. 您已阅读汉化相关注意事项:《Minecraft Mod简体中文翻译规范与指南》

  3. 您能够接受因汉化质量问题而提出的批评与建议

为本项目贡献汉化有以下两种方法:

使用Weblate翻译

  • 为了能够使用Weblate进行翻译,您需要向管理员索取您自己的wl账户,且基本熟悉wl的主要功能。

  • 请尽量在熟悉模组的情况下进行翻译,同时建议翻译时打开Minecraft以进行测试。

  • 您可以善用wl提供的词典功能,以方便您的汉化及提高汉化速度。

  • Weblate提供了机器翻译参考,请在深思熟虑的情况下才直接提交机翻文本。

  • Weblate提交汉化有一定的延迟时间,您的汉化将不会马上进入到汉化仓库中。

提交PullRequest

  • 您对Github的功能已经有了一定的了解,并且懂得使用PullRequest

  • 使用[R](需要审查)、[M](直接合并)、[P](难度较大)、[W](更改较多)、[WIP](未完成)标记PullRequest

  • 您愿意等待长时间的审核(部分可能长达一个月),并且在收到建议后愿意进行修改

  • 您能够确保提交文件的路径是正确

  • 审核都是,汉化也都是做的。处理PullRequest可能将不会那么及时。

  • 请勿对本地化修复文件做出任何改动

  • 请勿在提交汉化的Commit中同时更改配置以及代码,除非您明白且愿意承担所造成的相关后果

代码贡献指南

  • 我们默认您已了解C#Github Actions以及相关计算机的基本知识

  • 贡献代码有着更加严格的审查,请不要发无意义的、影响本项目运作的PR(例:SPAM

  • 在提交前,您已测试过你的代码能够正常的运行

  • 请简要描述提交的代码的作用

配置文件更改指南

建议更改的配置文件仅为config/spider/config.json,故其他文件不做说明

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

注意事项:

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

问题反馈

请发Issue或在QQ群、Discord群内反馈。

最后需要注意的

本项目对机翻,生硬汉化并不友好,还请在提交具有上述特征的文件时深思熟虑。

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