Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: translate help-wanted into Chinese #825

Merged
merged 1 commit into from
Jul 8, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/development/help-wanted.zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Help Wanted Issues 中文文档

这类 issue 既适用于新贡献者,也适用于一个想尝试探索项目其他模块的有经验的贡献者。

带有 "help wanted" 标签的 issue 需要满足以下标准:

- 此任务在项目中属于中低优先级。
- 低参与阻碍。这应该比 “good first issue" 难一些,但它的难度仍应被限定在合理的范围内。
- 对于新贡献者来说易驾驭。项目中应该存在如何进行此类修改的文档。
- 任务清楚明确,不需要进一步的讨论。如果该区域代码没有被测试过,或者需要新的 bugfix,应当指出。可能的话,给出一些相似的代码例子,作为参考。
- API/CLI 的具体行为表现应当在原始的 issue 中被决定附在 issue 中。例如:”这个新的命令的语法格式是:dtm xxx NAME [--some-flag] [--timeout 5m]"。并附上期望的输入参数校验、输出、错误处理方式。

关于创建 "help wanted issue" 的小提示:

- 只为那些不在项目规划的关键路径上的 issue 打上此标签,或者不需要马上完成的:如果你不希望把精力放在培养这些 issue 上,却因为它马上要立即完成,最后只能自己做的话。
- 时刻更新他们。定期复核这些 issue,保证他们还没有被实现、非紧急,以及 issue 上的推荐的解决策略或方案设计仍是合适的。