From dfbd1489371c77e0a2157c5f360aa290a077aff0 Mon Sep 17 00:00:00 2001 From: taotieren Date: Wed, 16 Dec 2020 17:53:25 +0800 Subject: [PATCH] =?UTF-8?q?update=20=E7=AC=AC3=E9=83=A8=E5=88=86=E2=80=94?= =?UTF-8?q?=E2=80=94=E5=B0=9D=E8=AF=95=E5=8F=82=E4=B8=8E=E5=BC=80=E6=BA=90?= =?UTF-8?q?/=E6=8F=90=E4=BA=A4=E7=AC=AC=E4=B8=80=E4=B8=AA=20Issue.md.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...\254\254\344\270\200\344\270\252 Issue.md" | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git "a/\347\254\2543\351\203\250\345\210\206\342\200\224\342\200\224\345\260\235\350\257\225\345\217\202\344\270\216\345\274\200\346\272\220/\346\217\220\344\272\244\347\254\254\344\270\200\344\270\252 Issue.md" "b/\347\254\2543\351\203\250\345\210\206\342\200\224\342\200\224\345\260\235\350\257\225\345\217\202\344\270\216\345\274\200\346\272\220/\346\217\220\344\272\244\347\254\254\344\270\200\344\270\252 Issue.md" index f514993..1770fd5 100644 --- "a/\347\254\2543\351\203\250\345\210\206\342\200\224\342\200\224\345\260\235\350\257\225\345\217\202\344\270\216\345\274\200\346\272\220/\346\217\220\344\272\244\347\254\254\344\270\200\344\270\252 Issue.md" +++ "b/\347\254\2543\351\203\250\345\210\206\342\200\224\342\200\224\345\260\235\350\257\225\345\217\202\344\270\216\345\274\200\346\272\220/\346\217\220\344\272\244\347\254\254\344\270\200\344\270\252 Issue.md" @@ -24,7 +24,7 @@ Issue 的翻译大致为**议题**、**问题**。 2. **问题列表 BUG LIST** - 一个复杂的项目难免会有这样或那样的 bug，而这些内容被观摩你仓库的朋友们发现之后，可以通过 Issue 给你提出，你可以根据他们指出的复现步骤来定位问题，并最终修复，让你所编写的项目更加健壮而强大。不要害怕自己代码写得很烂，感觉别人提 bug 就是在揭自己的短什么的，因为每发现一个 bug 意味着你的程序又少了一个缺陷，只需要快速修复它即可。当然，你也可以自己发现 bug，并给自己提出 Issue，目的是让自己的项目有充分的留痕，便于后续避免该问题或寻找解决方案。 + 一个复杂的项目难免会有这样或那样的 Bug，而这些内容被观摩你仓库的朋友们发现之后，可以通过 Issue 给你提出，你可以根据他们指出的复现步骤来定位问题，并最终修复，让你所编写的项目更加健壮而强大。不要害怕自己代码写得很烂，感觉别人提 Bug 就是在揭自己的短什么的，因为每发现一个 Bug 意味着你的程序又少了一个缺陷，只需要快速修复它即可。当然，你也可以自己发现 Bug，并给自己提出 Issue，目的是让自己的项目有充分的留痕，便于后续避免该问题或寻找解决方案。 3. **讨论版 BBS** @@ -37,8 +37,8 @@ Issue 的翻译大致为**议题**、**问题**。 所以，咱们总结下来，可以有如下结论： -* 对于你自己来说，自己可以使用 Issue 来发布待办清单，给自己提开发任务或 bug，开帖找大家探讨项目下一步的发展方向等等。当然，你也可以用它来提出一些跟仓库内容无关的事情，这也是允许的。 -* 如果你想要提 Issue 的仓库不是你自己的，而是他人的的时候，Issue 就是一个很好的多人协作系统。比如发现了别人项目的 bug 的时候；比如想要别人添加某个新功能的时候；比如有使用上的困难，需要求助作者使用步骤的时候，你都可以给别人的仓库提出 Issue。同时，如果你是一个热心的开发者，你也可以帮助原作者回答一些别人提出的 Issue，这样的行为可以极大地帮助原作者分担压力哦。不要觉得自己是在做临时免费工，解答的过程中你的知识和技术也会得到巩固和提高，有时还能结交到许多志同道合的好朋友哦。我助人，人亦助我。 +* 对于你自己来说，自己可以使用 Issue 来发布待办清单，给自己提开发任务或 Bug，开帖找大家探讨项目下一步的发展方向等等。当然，你也可以用它来提出一些跟仓库内容无关的事情，这也是允许的。 +* 如果你想要提 Issue 的仓库不是你自己的，而是他人的的时候，Issue 就是一个很好的多人协作系统。比如发现了别人项目的 Bug 的时候；比如想要别人添加某个新功能的时候；比如有使用上的困难，需要求助作者使用步骤的时候，你都可以给别人的仓库提出 Issue。同时，如果你是一个热心的开发者，你也可以帮助原作者回答一些别人提出的 Issue，这样的行为可以极大地帮助原作者分担压力哦。不要觉得自己是在做临时免费工，解答的过程中你的知识和技术也会得到巩固和提高，有时还能结交到许多志同道合的好朋友哦。我助人，人亦助我。 @@ -51,7 +51,7 @@ Issue 的翻译大致为**议题**、**问题**。 #### Issue 的礼仪[2] 1. 提问使用的语言 ：第一，参照维护者的母语，如果仓库所有者的母语是中文则建议优先中文交流。第二，如果不清楚应该使用什么语言，建议选择英文交流。 -2. 提问态度和语气 ：因为你面对的是跟你一样的开发者，不卑不亢，虚心求教就可以了，不必要太咋呼，措辞太夸张等。但是言语之间要表示对作者的尊重，最好多使用`请`、`谢谢`、`please`、`thanks`等词语。 +2. 提问态度和语气 ：因为你面对的是跟你一样的开发者，不卑不亢，虚心求教就可以了，不必要太咋呼，措辞太夸张等。但是言语之间要表示对作者的尊重，最好多使用`请`、`谢谢`、`Please`、`Thanks`等词语。 3. **如有 Issue 模板，请参照模板写 Issue**。如果原作者定义了 Issue 模板，请按模板来写，避免挤牙膏式的交流。如没有，本文会有比较通用的模板提供给大家。总之，撰写的原则是，把事情表述清楚，便于原作者处理和与你交流。 #### 一个好 Issue 的标准[2] @@ -71,7 +71,7 @@ Issue 的翻译大致为**议题**、**问题**。 先使用方括号（也可以使用`【】`替代方括号），里面写上分类、标签或某文件名（比如这个文件有问题待修改），这部分是便于作者进行问题分类的，也方便其他协作者查找（很多人提 Issue 并没有这一部分，建议加上）。然后使用简短的描述，可以让人通过标题快速了解这个 Issue 是讲什么内容的。 -案例：`[bug]app.py文件173行运行报错，疑似遗漏一个=号` +案例：`[Bug]app.py文件173行运行报错，疑似遗漏一个=号` #### 提出一个 Issue @@ -95,7 +95,7 @@ Issue 的翻译大致为**议题**、**问题**。 在 Gitee 中，支持在新建仓库时创建 Issue 模板，也支持自定义模板。 -在新建仓库时，勾选`使用Issue模板文件初始化这个项目`，实际上就是在仓库根目录下新建了 `.gitee/ISSUE_TEMPLATE.zh-CN.md` 文件，当然你也可以自己创建这个文件，来编写自己的模板。 +在新建仓库时，勾选`使用 Issue 模板文件初始化这个项目`，实际上就是在仓库根目录下新建了 `.gitee/ISSUE_TEMPLATE.zh-CN.md` 文件，当然你也可以自己创建这个文件，来编写自己的模板。 ![选择使用模板来初始化项目](https://images.gitee.com/uploads/images/2020/1104/184559_3f5d281c_1277510.png "image-20201104183636294.png") @@ -107,7 +107,7 @@ Issue 的翻译大致为**议题**、**问题**。 > Q: 不同类型的模板，有什么作用？ > -> A: 例如你的仓库中有 3 种语言类型的 Issue 模板，提交 Issue 的用户使用的是英文版，那么当用户勾选`使用Issue模板`，则会智能地使用英文模板，如果对方使用的是中文版则会智能地使用中文 Issue 模板。 +> A: 例如你的仓库中有 3 种语言类型的 Issue 模板，提交 Issue 的用户使用的是英文版，那么当用户勾选`使用 Issue 模板`，则会智能地使用英文模板，如果对方使用的是中文版则会智能地使用中文 Issue 模板。 当你在敲标题或者 Issue 内容时，项目会自动显示已有的类似 Issue，你可以先查看一下推荐的 Issue 能否解决你的问题，如果不能再提出，避免反复提出同一个问题。 @@ -205,7 +205,7 @@ Issue 的翻译大致为**议题**、**问题**。 * **里程碑**：里程碑是某功能或某个时间段的一堆问题的集合。比如我们要写一本书，一个章节如果设置为一个里程碑，那这个章节里面的每一个小节我们就可以分别提多个 Issue，最后将这些 Issue 关联到这个章节的里程碑中，方便管理，可以很容易看到整个章节的完成进度。我们可以根据自己的需要，来使用里程碑的功能。下面是一些使用里程碑功能的例子[1]： - - **发布测试**——在你发布项目的 Beta 版之前，包含你需要修复的 bug 文件相关的 Issue。这样可以确保你不会漏掉什么。 + - **发布测试**——在你发布项目的 Beta 版之前，包含你需要修复的 Bug 文件相关的 Issue。这样可以确保你不会漏掉什么。 - **十月冲刺**——记录你在十月份应该做的问题清单。相当于一个工作清单，时刻提醒你应该重点完成哪些工作。（当然，你设定一个九月要做的事情的清单也是可以的） - **重新设计**——记录与重新设计项目的问题清单。这是一种收集灵感的好方法。 @@ -215,9 +215,9 @@ Issue 的翻译大致为**议题**、**问题**。 ![新建里程碑](https://images.gitee.com/uploads/images/2020/1104/122051_3d9f8f40_1277510.png "image-20201104104505287.png") - 新建完成后即可在Issue中关联： + 新建完成后即可在 Issue 中关联： - ![新建完成后即可在Issue中关联](https://images.gitee.com/uploads/images/2020/1104/122123_f025a6a2_1277510.png "image-20201104104609496.png") + ![新建完成后即可在 Issue 中关联](https://images.gitee.com/uploads/images/2020/1104/122123_f025a6a2_1277510.png "image-20201104104609496.png") * **关联分支**：这里可以选择关联到该仓库的哪个分支。 @@ -241,7 +241,7 @@ Issue 在提出之后，对于个人版来说可以有四种状态：待办的 > 状态变更之后，允许再次变更，比如设置为`已完成`状态的 Issue，可以再次修改为`进行中`。 -![Issue的状态切换](https://images.gitee.com/uploads/images/2020/1104/122341_7c087174_1277510.png "image-20201104120709716.png") +![Issue 的状态切换](https://images.gitee.com/uploads/images/2020/1104/122341_7c087174_1277510.png "image-20201104120709716.png") 我们还可以在`看板`中看到处于每种状态的 Issue 的列表。 @@ -257,7 +257,7 @@ Issue 在提出之后，对于个人版来说可以有四种状态：待办的 找到 Issue 编号（这里为 `#I23WUE`）： -![找到Issue编号](https://images.gitee.com/uploads/images/2020/1104/151115_93315a5e_1277510.png "image-20201104141131901.png") +![找到 Issue 编号](https://images.gitee.com/uploads/images/2020/1104/151115_93315a5e_1277510.png "image-20201104141131901.png") 支持快速点击，提交 Issue 之后会自动生成链接，链接到该 Issue： @@ -269,11 +269,11 @@ Issue 在提出之后，对于个人版来说可以有四种状态：待办的 > 当你将各种 Issue 维护好对应的标签之后，可以快速找到属于某个标签的 Issue 结果进行处理。 -![快速搜索Issue](https://images.gitee.com/uploads/images/2020/1104/151211_cfa06098_1277510.png "image-20201104142549944.png") +![快速搜索 Issue](https://images.gitee.com/uploads/images/2020/1104/151211_cfa06098_1277510.png "image-20201104142549944.png") -#### 在 commit 中关闭 Issue +#### 在 Commit 中关闭 Issue -比如在修复一个 bug 时，某一次 commit 就是解决了提这个 bug 的 Issue 的，那么我们可以轻松的在 commit 的内容中附带上一些特殊信息（在 commit 信息中或者附加信息中均可），来自动关闭 Issue。 +比如在修复一个 Bug 时，某一次 Commit 就是解决了提这个 Bug 的 Issue 的，那么我们可以轻松的在 Commit 的内容中附带上一些特殊信息（在 Commit 信息中或者附加信息中均可），来自动关闭 Issue。 Gitee 支持的提交方式有（比如我们需要关闭的 Issue 编号为 24，`+`号表示在提交的内容中添加后面部分的内容）[4]： @@ -288,7 +288,7 @@ Gitee 支持的提交方式有（比如我们需要关闭的 Issue 编号为 24 + resolved #24 ``` -![在提交的内容中添加关闭Issue的信息](https://images.gitee.com/uploads/images/2020/1104/151238_25c34fd1_1277510.png "image-20201104144448225.png") +![在提交的内容中添加关闭 Issue 的信息](https://images.gitee.com/uploads/images/2020/1104/151238_25c34fd1_1277510.png "image-20201104144448225.png") #### Issue 中的待办清单 -- Gitee