diff --git a/zh-cn/contributing/index.md b/zh-cn/contributing/index.md index e69de29..667391c 100644 --- a/zh-cn/contributing/index.md +++ b/zh-cn/contributing/index.md @@ -0,0 +1,40 @@ +# 贡献 Epherome + +Epherome 使用 GitHub 作为其唯一的源代码管理、开发、协作和持续集成平台。 + +要对 Epherome 做出贡献,您需要学习关于 Git 和 GitHub 的一些基础知识。 + +本文介绍了 Epherome 贡献的基本工作流程。 + +## Forking + +要开始 Epherome 的工作,您需要在 GitHub 上 "fork" 该 Repository 。 + +Forking 后,您将拥有自己的 Repository `{username}/Epherome`,其内容与您 Fork 时 Epherome Repository 的内容相同。**但是您需要手动与 Upstream repository 同步。** + +*Upstream Repository* 是指该 Repository Fork 自的 Repository 。在本文档中,Upstream Repository 指的是 `ResetPower/Epherome` + +您可以使用命令行 `git clone https://github.com/{username}/Epherome` 或者 `gh repo clone {username}/Epherome` 将 Repository 克隆到您的本地文件系统。 + +## 开发 + +- 打开命令行,并使用 `cd` 命令切换到包含 `package.json`的 `Epherome`目录。 +- 使用 `npm install`来安装必要的包。 +- 使用 `npm run tauri dev` 来在开发模式下运行 Epherome。 + +Epherome 使用 Tauri 作为其后端。获取更多详细的操作,您可以参阅 Tauri 文档。 + +完成以上步骤后,您可以开始编辑代码。 + +## 发起 Pull Request (PR) + +- 将修改提交到您的 Repository ,即 `{username}/Epherome`。 +- 在您的 Repository 页面上发起一个 Pull Request (PR)。 + +> 尽您最大的努力去遵循提交信息规范。您可以模仿 Epherome 的提交信息来开始。 +> +> 具体地说,提交信息应该按 `type(scope): ` 的格式撰写。 +> 短摘要可以是名词、符号或动词短语。请注意,任何动词都应用现在时。 +> scope可以省略,就像 Epherome 做的那样。 +> +> 但是这**并不重要**,因为作者在使用 *Squash and Merge* 时可以重写提交信息。 \ No newline at end of file diff --git a/zh-cn/contributing/translations.md b/zh-cn/contributing/translations.md index e69de29..e266a71 100644 --- a/zh-cn/contributing/translations.md +++ b/zh-cn/contributing/translations.md @@ -0,0 +1,34 @@ +# 帮助翻译 Ephorome + +Epherome 使用了一个国际化系统。您可以在 Epherome 的通用设置中修改 *显示语言*。 + +## 介绍 + +此系统的代码位于 `src/intl` 。 + +- `src/intl/index.ts` 是此系统的核心。 +- `src/intl/root.ts` 是 *全球英语* `(en-ww)` 的定义文件,它也定义了 `LanguageMessages` 类型。 + +## 完善已有的语言 + +- `src/intl/{language-code}.ts` 是语言定义文件。只需填充其中的 `messages`。 + +> 有两种类型的国际化消息, `string` 和 `function`。 +> +> 如果你不知道该如何操作,最好的方法是参考 `src/intl/root.ts` 是如何做的。 + +## 创建新语言 + +- 创建新文件 `src/intl/{language-code}.ts`。 +- 将以下内容写入文件: +```typescript +export default { + name: "{language-name}", + code: "{language-code}", + messages: { + // ... + }, +} +``` + +在上述文件中, *language-name* 是该语言本身的名称。例如,希腊语的 *language-name* 是 `Ελληνικά,而希腊语的 *language-code* 是 `el-gr`。 \ No newline at end of file