-
-
Notifications
You must be signed in to change notification settings - Fork 624
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add Simplified Chinese translation
- Loading branch information
Showing
15 changed files
with
3,092 additions
and
100 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
andreynering: | ||
name: Andrey Nering | ||
title: Task 项目维护者 | ||
url: https://github.com/andreynering | ||
image_url: https://github.com/andreynering.png |
266 changes: 266 additions & 0 deletions
266
docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/api_reference.md
Large diffs are not rendered by default.
Oops, something went wrong.
438 changes: 438 additions & 0 deletions
438
docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/changelog.md
Large diffs are not rendered by default.
Oops, something went wrong.
50 changes: 50 additions & 0 deletions
50
docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/community.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
--- | ||
slug: /community/ | ||
sidebar_position: 8 | ||
--- | ||
|
||
# 社区 | ||
|
||
一些改善 Task 生态的工作是由社区完成,包括安装方法或代码编辑器集成。 我(指作者)非常感谢所有帮助提升整体体验的人们。 | ||
|
||
## 翻译 | ||
|
||
[@DeronW](https://github.com/DeronW) 在 [此存储库](https://github.com/DeronW/task) 中维护网站的 [中文翻译](https://task-zh.readthedocs.io/zh_CN/latest/)。 | ||
|
||
## 编辑器集成 | ||
|
||
### JSON Schema | ||
|
||
Schema 的初步工作是由 [@KROSF](https://github.com/KROSF) 在此 [Gist](https://gist.github.com/KROSF/c5435acf590acd632f71bb720f685895) 上完成的。 这个 Schema 目前在 https://taskfile.dev/schema.json 上可用,并在 https://json.schemastore.org/taskfile.json 上添加了链接,因此它可以自动在许多代码编辑器使用,例如 VSCode。 可以通过编辑 [此文件](https://github.com/go-task/task/blob/master/docs/static/schema.json) 来完成贡献。 | ||
|
||
### Visual Studio Code 扩展 | ||
|
||
另外,在开发 Visual Studio Code 扩展过程中, 还有一些工作由 [@paulvarache](https://github.com/paulvarache) 完成, 代码在 [这里](https://github.com/paulvarache/vscode-taskfile) 并发布到了 [这里](https://marketplace.visualstudio.com/items?itemName=paulvarache.vscode-taskfile)。 | ||
|
||
### Sublime Text 4 包 | ||
|
||
通过 Sublime Text 的命令面板有一个简便的安装运行方法。 这个包是由 [@biozz](https://github.com/biozz) 开发的, 源代码在 [这里](https://github.com/biozz/sublime-taskfile) 并且发布到了包管理 [这里](https://packagecontrol.io/packages/Taskfile)。 | ||
|
||
### IntelliJ 插件 | ||
|
||
JetBrains IntelliJ 插件由 [@lechuckroh](https://github.com/lechuckroh) 完成, 代码在 [这里](https://github.com/lechuckroh/task-intellij-plugin) 并且发布到了 [这里](https://plugins.jetbrains.com/plugin/17058-taskfile)。 | ||
|
||
## 其他集成 | ||
|
||
- [mk](https://github.com/pycontribs/mk) 命令行工具可以原生识别任务文件。 | ||
|
||
## 安装方法 | ||
|
||
有些安装方式是通过第三方维护的: | ||
|
||
- [GitHub Actions](https://github.com/arduino/setup-task) 由 [@arduino](https://github.com/arduino) 维护 | ||
- [AUR](https://aur.archlinux.org/packages/go-task-bin) 由 [@carlsmedstad](https://github.com/carlsmedstad) 维护 | ||
- [Scoop](https://github.com/lukesampson/scoop-extras/blob/master/bucket/task.json) | ||
- [Fedora](https://packages.fedoraproject.org/pkgs/golang-github-task/go-task/) | ||
- [NixOS](https://github.com/NixOS/nixpkgs/blob/master/pkgs/development/tools/go-task/default.nix) | ||
|
||
## 更多 | ||
|
||
同时,感谢所有 [代码贡献者](https://github.com/go-task/task/graphs/contributors), [资金赞助](https://opencollective.com/task),以及 [提交问题](https://github.com/go-task/task/issues?q=is%3Aissue) 和 [解答问题](https://github.com/go-task/task/discussions) 的人。 | ||
|
||
如果你发现文档有哪些遗漏信息,欢迎提交 pull request。 |
69 changes: 69 additions & 0 deletions
69
docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/contributing.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
--- | ||
slug: /contributing/ | ||
sidebar_position: 9 | ||
--- | ||
|
||
# 贡献 | ||
|
||
非常欢迎对 Task 的贡献,但我们要求您在提交 PR 之前阅读本文档。 | ||
|
||
## 开始之前 | ||
|
||
- **检查已有工作** - 是否已经存在 PR? 是否存在 Issue 正在讨论您要进行的功能/更改? 请确保你的工作中确实考虑了这些相关的讨论内容。 | ||
- **向后兼容** - 你的变更是否破坏了已经存在的 Taskfile? 向后兼容的变更会更容易被合并进去。 您是否可以采取一种方法来保持这种兼容性? 如果没有,请考虑先提出一个 Issue,以便在您投入时间进行 PR 之前讨论 API 的更改。 | ||
|
||
## 1. 设置 | ||
|
||
- **Go** - Task 使用 [Go](https://go.dev) 编写。 我们始终支持最新的两个主要 Go 版本,因此请确保您的版本足够新。 | ||
- **Node.js** - [Node.js](https://nodejs.org/en/) 用于托管 Task 的文档服务器,如果您想在本地运行此服务器,则需要它。 | ||
- **Yarn** - [Yarn](https://yarnpkg.com/) 是 Task 使用的 Node.js 包管理器。 | ||
|
||
## 2. 进行变更 | ||
|
||
- **代码风格** - 尽量保持现有的代码风格,并确保代码采用 `gofmt`。 我们在我们的 CI 中使用 `golangci-lint` 来强制执行一致的风格和最佳实践。 Taskfile 中有一个 `lint` 命令可以在本地运行。 | ||
- **文档** - 确保添加/更新了相关文档。 请参阅下面的 [更新文档](#更新文档) 部分。 | ||
- **测试** - 确保添加/更新了相关测试,并且在提交 PR 前已通过所有测试。 请参阅下面的 [编写测试](#编写测试) 部分。 | ||
|
||
### 运行您的变更 | ||
|
||
要运行带有工作变更的任务,您可以使用 `go run ./cmd/task`。 要针对 `testdata` 中的测试任务文件运行任务的开发构建,您可以使用 `go | ||
run ./cmd/task --dir ./testdata/<my_test_dir> <task_name>`。 | ||
|
||
### 更新文档 | ||
|
||
Task 用 [Docusaurus](https://docusaurus.io) 托管文档服务。 这可以通过使用 `task docs`(需要 `nodejs` 和 `yarn`)在本地设置和运行。 所有内容均使用 Markdown 编写,位于 `docs/docs` 目录中。 所有 Markdown 文档都应有 80 个字符的换行限制。 | ||
|
||
进行变更时,请考虑是否有必要更改 [使用指南](./usage.md)。 本文档包含有关如何使用任务功能的说明和示例。 如果您要添加新功能,请尝试找到合适的位置来添加新部分。 如果您要更新现有功能,请确保文档和所有示例都是最新的。 确保任何示例都遵循 [Taskfile 风格指南](./styleguide.md)。 | ||
|
||
如果您添加了新字段、命令或标志,请确保将其添加到 [API 参考](./api_reference.md) 中。 还需要将新字段添加到 [JSON Schema](https://github.com/go-task/task/blob/master/docs/static/schema.json) 中。 API 参考和 schema 中的字段描述应该匹配。 | ||
|
||
### 编写测试 | ||
|
||
Task 的大部分测试都保存在项目根目录的 `task_test.go` 文件中并且这是您最有可能想要添加新测试的地方。 这些测试中的大多数在目录中还有一个 `testdata` 子目录,其中存储了运行测试所需的 Taskfiles/数据。 | ||
|
||
进行更改时,请考虑是否需要添加新的测试。 这些测试应确保您添加的功能在未来持续工作。 如果您更改了任务的行为,现有测试可能也需要更新。 | ||
|
||
## 3. 提交代码 | ||
|
||
编写有意义的提交信息,避免一个 PR 上有太多提交。 大多数PR应该有一个提交(尽管对于较大的PR来说,把它分成几个提交可能是合理的)。 Git squash和rebase是你的好朋友! | ||
|
||
## 4. 提交 PR | ||
|
||
- **描述变更** - 确保您提供对更改的全面描述。 | ||
- **Issue/PR 链接** - 链接到之前相关的 Issue 或 PR。 请描述当前工作与之前的不同之处。 | ||
- **示例** - 添加您认为有助于展示变更效果的示例。 | ||
- **PR 草案** - 如果变更还未完成,但您想讨论它们,请将 PR 作为草稿打开并添加评论以开始讨论。 使用评论而不是 PR 描述允许稍后更新描述,同时保留讨论。 | ||
|
||
## 常见问题 | ||
|
||
> 我想贡献,我从哪里开始? | ||
查看 [未解决 Issue](https://github.com/go-task/task/issues) 的列表。 我们有一个 [good first issue](https://github.com/go-task/task/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) 标签,用于更简单的 Issue,非常适合首次贡献。 | ||
|
||
欢迎各种贡献,无论是拼写错误修复还是很小的新功能。 您还可以通过对 Issue 进行投票/评论、帮助回答问题或帮助 [其他社区项目](./community.md) 来做出贡献。 | ||
|
||
> 我被困住了,我在哪里可以获得帮助? | ||
如果您有任何疑问,请随时在我们的 [Discord 服务器](https://discord.gg/6TY36E39UK) 上的 `#help` 论坛频道中提问,或在 GitHub 上打开 [讨论](https://github.com/go-task/task/discussions)。 | ||
|
||
--- |
39 changes: 39 additions & 0 deletions
39
docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/donate.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
slug: /donate/ | ||
sidebar_position: 12 | ||
--- | ||
|
||
# 赞助 | ||
|
||
如果您觉得这个项目有用,您可以考虑使用下面列出的渠道之一进行捐赠。 | ||
|
||
这只是一种表达“感谢”的方式,它不会给你任何好处,比如在 Issue 上的更高优先级或类似的东西。 | ||
|
||
每月捐赠至少 50 美元的公司将在网站主页和 GitHub 存储库 README 中被标为“金牌赞助商”。 请与 [@andreynering](https://github.com/andreynering) 联系,说明你希望显示的标志。 不过,可疑的企业(赌博、赌场等)将不被允许。 | ||
|
||
## GitHub Sponsors | ||
|
||
捐赠给维护者的首选方式是通过 GitHub Sponsors。 只需使用以下链接就可以进行捐赠: | ||
|
||
- [@andreynering](https://github.com/sponsors/andreynering) | ||
- [@pd93](https://github.com/sponsors/pd93) | ||
|
||
## Open Collective | ||
|
||
如果你喜欢 [Open Collective](https://opencollective.com/task),你可以通过这些链接进行捐赠: | ||
|
||
- [每月 2 美元](https://opencollective.com/task/contribute/backer-4034/checkout) | ||
- [每月 5 美元](https://opencollective.com/task/contribute/supporter-8404/checkout) | ||
- [每月 20 美元](https://opencollective.com/task/contribute/sponsor-4035/checkout) | ||
- [每月 50 美元](https://opencollective.com/task/contribute/sponsor-28775/checkout) | ||
- [自定义金额 - 支持一次性捐赠选项](https://opencollective.com/task/donate) | ||
|
||
## PayPal | ||
|
||
你也可以通过 PayPal 向 [@andreynering](https://github.com/andreynering) 捐款。 | ||
|
||
- [任何金额 - 一次性捐款](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=GSVDU63RKG45A¤cy_code=USD&source=url) | ||
|
||
## PIX (仅巴西) | ||
|
||
如果你是巴西人,你也可以通过 PIX [使用这个QR码](/img/pix.png) 向 [@andreynering](https://github.com/andreynering) 捐款。 |
40 changes: 40 additions & 0 deletions
40
docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current/faq.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
slug: /faq/ | ||
sidebar_position: 5 | ||
--- | ||
|
||
# 常见问题 | ||
|
||
此页面包含有关 Task 的常见问题列表。 | ||
|
||
- [为什么我的 task 不会更新我的 shell 环境?](#为什么我的-task-不会更新我的-shell-环境) | ||
- [内置的 'x' 命令在 Windows 上不起作用](#内置的-x-命令在-windows-上不起作用) | ||
|
||
## 为什么我的 task 不会更新我的 shell 环境? | ||
|
||
这是 shell 工作方式的限制。 任务作为当前 shell 的子进程运行,因此它不能更改启动它的 shell 的环境。 其他任务运行器和构建工具也有此限制。 | ||
|
||
解决此问题的一种常见方法是创建一个 task,该任务将生成可由您的 shell 解析的输出。 例如,要在 shell 上设置环境变量,您可以编写如下任务: | ||
|
||
```yaml | ||
my-shell-env: | ||
cmds: | ||
- echo "export FOO=foo" | ||
- echo "export BAR=bar" | ||
``` | ||
现在运行 `eval $(task my-shell-env)` 变量 `$FOO` 和 `$BAR` 将在您的 shell 中可用。 | ||
|
||
## 内置的 'x' 命令在 Windows 上不起作用 | ||
|
||
Windows 上的默认 shell(`cmd` 和 `powershell`)没有像 `rm` 和 `cp` 这样的内置命令。 这意味着这些命令将不起作用。 如果你想让你的 Taskfile 完全跨平台,你需要使用以下方法之一来解决这个限制: | ||
|
||
- 使用 `{{OS}}` 函数运行特定于操作系统的脚本。 | ||
- 使用 `{{if eq OS "windows"}}powershell {{end}}<my_cmd>` 之类的东西来检测 windows 并直接在 Powershell 中运行命令。 | ||
- 在 Windows 上使用支持这些命令的 shell 作为内置命令,例如 [Git Bash](https://gitforwindows.org/) 或 [WSL](https://learn.microsoft.com/en-us/windows/wsl/install)。 | ||
|
||
我们希望对 Task 的这一部分进行改进,下面的 Issue 会跟踪这项工作。 非常欢迎建设性的意见和贡献! | ||
|
||
- [#197](https://github.com/go-task/task/issues/197) | ||
- [mvdan/sh#93](https://github.com/mvdan/sh/issues/93) | ||
- [mvdan/sh#97](https://github.com/mvdan/sh/issues/97) |
Oops, something went wrong.