diff --git "a/\347\254\254\344\270\211\351\203\250\345\210\206\357\274\232\345\260\235\350\257\225\345\217\202\344\270\216\345\274\200\346\272\220/\347\254\254 6 \345\260\217\350\212\202\357\274\232\346\217\220\344\272\244\347\254\254\344\270\200\344\270\252 Issue.md" "b/\347\254\254\344\270\211\351\203\250\345\210\206\357\274\232\345\260\235\350\257\225\345\217\202\344\270\216\345\274\200\346\272\220/\347\254\254 6 \345\260\217\350\212\202\357\274\232\346\217\220\344\272\244\347\254\254\344\270\200\344\270\252 Issue.md" index 6aa0e49690d4c58b02ec0e03951f5d905e58c277..6c8b9a88bfa0cee01daabd18cd453ca26edacb3c 100644 --- "a/\347\254\254\344\270\211\351\203\250\345\210\206\357\274\232\345\260\235\350\257\225\345\217\202\344\270\216\345\274\200\346\272\220/\347\254\254 6 \345\260\217\350\212\202\357\274\232\346\217\220\344\272\244\347\254\254\344\270\200\344\270\252 Issue.md" +++ "b/\347\254\254\344\270\211\351\203\250\345\210\206\357\274\232\345\260\235\350\257\225\345\217\202\344\270\216\345\274\200\346\272\220/\347\254\254 6 \345\260\217\350\212\202\357\274\232\346\217\220\344\272\244\347\254\254\344\270\200\344\270\252 Issue.md" @@ -1,5 +1,6 @@ # 第 6 小节：提交第一个 Issue -### 什么是 Issue + +## 什么是 Issue Issue 的翻译大致为**议题**、**问题**。 @@ -11,7 +12,7 @@ Issue 的翻译大致为**议题**、**问题**。 而根据 Gitee 官方的建议，项目相关的技术问题、缺陷报告、建议等信息都可以通过 Issue 进行发布。 -### 什么情况下需要提交 Issue +## 什么情况下需要提交 Issue 那么什么情况下需要提交 Issue 呢？ @@ -41,19 +42,19 @@ Issue 的翻译大致为**议题**、**问题**。 * 对于你自己来说，可以使用 Issue 来发布待办清单，给自己提开发任务或 Bug，开帖找大家探讨项目下一步的发展方向等等。当然，你也可以用它来提出一些跟仓库内容无关的事情，这也是允许的。 * 如果你想要提 Issue 的仓库不是你自己的，而是他人的的时候，Issue 就是一个很好的多人协作系统。比如发现了别人项目的 Bug 的时候；比如想要别人添加某个新功能的时候；比如有使用上的困难，需要求助作者使用步骤的时候，你都可以给别人的仓库提出 Issue。同时，如果你是一个热心的开发者，你也可以帮助原作者回答一些别人提出的 Issue，这样的行为可以极大地帮助原作者分担压力哦。不要觉得自己是在做临时免费工，解答的过程中你的知识和技术也会得到巩固和提高，有时还能结交到许多志同道合的好朋友哦。我助人，人亦助我。 -### 一个好的 Issue 应该写些什么 +## 一个好的 Issue 应该写些什么 那么一个好的 Issue 应该写点什么呢？ 这一点对于外部协作者来说尤为重要，因为你要提的 Issue 不是在自己的地盘上，而是需要得到别人的帮助的，所以你尤其要注意 Issue 的礼仪。 -#### Issue 的礼仪[2] +### Issue 的礼仪[2] 1. 提问使用的语言：在主要面向母语为中文的开发者的开源平台，首选中文。在其他开源平台，首选仓库维护者的母语进行交流，如果不确定或有困难，建议选择英文交流。 2. 提问态度和语气：因为你面对的是跟你一样的开发者，不卑不亢，虚心求教就可以了，不必要太咋呼，措辞太夸张等。但是言语之间要表示对作者的尊重，最好多使用`请`、`谢谢`、`Please`、`Thanks`等词语。 3. **如有 Issue 模板，请参照模板写 Issue**。如果原作者定义了 Issue 模板，请按模板来写，避免挤牙膏式的交流。如没有，本文会有比较通用的模板提供给大家。总之，撰写的原则是，把事情表述清楚，便于原作者处理和与你交流。 -#### 一个好 Issue 的标准[2] +### 一个好 Issue 的标准[2] 1. 避免使用术语或晦涩的文字，尽量不要堆砌术语即可，不是说禁止使用术语； 2. 问题可以切分，也就是说可以逐步解决的问题； @@ -64,7 +65,7 @@ Issue 的翻译大致为**议题**、**问题**。 > 如果你是仓库的拥有者，你还可以编写一个 `CONTRIBUTE.md` 文件放在项目中，用来告知其他开发者需要如何参与你的项目。 -#### Issue 的标题怎么写？[2] +### Issue 的标题怎么写？[2] 格式：`[分类、标签或某文件名] + 简短描述` @@ -72,7 +73,7 @@ Issue 的翻译大致为**议题**、**问题**。 案例：`[Bug]app.py文件 173 行运行报错，疑似遗漏一个=号` -#### 提出一个 Issue +### 提出一个 Issue 咱们先来给一个 Gitee 官方通用的模板： @@ -108,7 +109,7 @@ Issue 的翻译大致为**议题**、**问题**。 好了，当你完成 Issue 主体内容的填写之后，快去提交给作者吧！ -### Issue 案例（有价值和无价值） +## Issue 案例（有价值和无价值） 下面我们来看几个 Issue 的案例。 @@ -154,11 +155,11 @@ Issue 的翻译大致为**议题**、**问题**。 因此，Issue 的精准表述是能获得良好协作的基础，提 Issue 也是一种很好的练习表达的方式。 -### Issue 的进阶使用 +## Issue 的进阶使用 掌握了 Issue 的基础使用之后，作为一个优秀的开发者，我们还可以掌握一些进阶的知识，它能让你压榨干净 Issue 的每一分价值。 -#### Issue 的详细设置 +### Issue 的详细设置 如果仓库是你自己的，你可以在每一个 Issue 的面板看到更多的进阶选项，如图所示： @@ -226,7 +227,7 @@ Issue 的翻译大致为**议题**、**问题**。 ![优先级](https://images.gitee.com/uploads/images/2020/1104/122301_aeea5b92_1277510.png "image-20201104120303417.png") -#### Issue 的状态和看板 +### Issue 的状态和看板 Issue 在提出之后，对于个人版来说可以有四种状态：待办的、进行中、已完成、已拒绝。负责人或者协作者可以修改该状态。企业版会可选更多的状态。 @@ -238,13 +239,13 @@ Issue 在提出之后，对于个人版来说可以有四种状态：待办的 ![看板页面](https://images.gitee.com/uploads/images/2020/1104/122400_f9648c84_1277510.png "image-20201104120934433.png") -#### @ 提及别人 +### 使用 `@` 提及别人 -使用`@`符号可以在 Issue 提出或者问题讨论的过程中提及别人，起到被 `艾特`的效果。 +使用 `@` 符号可以在 Issue 提出或者问题讨论的过程中提及别人，起到被 `艾特`的效果。 -#### # 关联其他 Issue +### 使用 `#` 关联其他 Issue -使用`#`符号再加上其他 Issue 的编号，可以关联到其它的 Issue。找到本仓库下 Issue 的编号之后写上即可。 +使用 `#` 符号再加上其他 Issue 的编号，可以关联到其它的 Issue。找到本仓库下 Issue 的编号之后写上即可。 找到 Issue 编号（这里为 `#I23WUE`）： @@ -254,7 +255,7 @@ Issue 在提出之后，对于个人版来说可以有四种状态：待办的 ![支持快速点击](https://images.gitee.com/uploads/images/2020/1104/151142_abdbc1da_1277510.png "image-20201104141338952.png") -#### 通过筛选器快速找到 Issue +### 通过筛选器过滤 Issue 可以通过搜索框输入关键词搜索 Issue，也可以通过下方的一些搜索条件来搜索 Issue。有了筛选器，当我们的 Issue 非常多时，我们就可以在众多的 Issue 中找到自己需要的 Issue 了。 @@ -262,7 +263,7 @@ Issue 在提出之后，对于个人版来说可以有四种状态：待办的 ![快速搜索 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。 @@ -281,7 +282,7 @@ Gitee 支持的提交方式有（比如我们需要关闭的 Issue 编号为 24 ![在提交的内容中添加关闭 Issue 的信息](https://images.gitee.com/uploads/images/2020/1104/151238_25c34fd1_1277510.png "image-20201104144448225.png") -#### Issue 中的待办清单 +### Issue 中的待办清单 不知道大家是否在 Issue 中有一些任务需要分步骤完成呢？如下面示例的 Issue，可以实现待办清单的功效[4]。可以根据后续的需要，勾选或者取消勾选待办清单中的分项任务，实现 checklist 的效果。 @@ -305,17 +306,15 @@ Gitee 支持的提交方式有（比如我们需要关闭的 Issue 编号为 24 > 请注意，设置未勾选状态时，方括号之间会有一个空格`[ ]`，不要漏掉了。 -### 参考资料 - -[1] [了解Issues](https://guides.github.com/features/issues/) - -[2] [正确的提问方式](https://zhuanlan.zhihu.com/p/75691927) +## 参考资料 -[3] [Issue标签说明](https://blog.csdn.net/lovewinner/article/details/80763629) +- [1] [了解Issues](https://guides.github.com/features/issues/) +- [2] [正确的提问方式](https://zhuanlan.zhihu.com/p/75691927) +- [3] [Issue标签说明](https://blog.csdn.net/lovewinner/article/details/80763629) +- [4] [Issue的使用](https://www.jianshu.com/p/5ba1e7f5ad70) -[4] [Issue的使用](https://www.jianshu.com/p/5ba1e7f5ad70) +## 本部分内容贡献者 -### 本部分内容贡献者 -[雪山凌狐](https://gitee.com/xueshanlinghu)、[taotieren](https://gitee.com/taotieren)、[吴烜](https://gitee.com/zhishi) +[雪山凌狐](https://gitee.com/xueshanlinghu)、[taotieren](https://gitee.com/taotieren)、[吴烜](https://gitee.com/zhishi)、[阿基米东](https://gitee.com/luhuadong) > 发现内容中的错误？还是想要补充更多符合主题的内容？《开源指北》欢迎你进行贡献，点击[贡献指南](./../贡献指南.md)了解贡献的具体步骤。 \ No newline at end of file