Open XIU2 opened 3 months ago
刚才提了个 BUG 反馈的 Issues,看到了你置顶写的 BUG 反馈/功能建议 格式要求,但是很多 Issues 压根不遵守格式(可能没看到?也可能是嫌麻烦?或者说不懂这些?),建议你参考我的几个项目添加两个 Issues 模板来解决该问题(至少能大大减少)。
我几乎给我的所有项目都添加了 Issues 模板,我这些项目点击 [New Issues] 时出现的页面是这样:
[New Issues]
截图来自: https://github.com/XIU2/CloudflareSpeedTest/issues/new/choose
点击 反馈问题 模板后面的 Get started 就是这样:
反馈问题
Get started
https://github.com/XIU2/CloudflareSpeedTest/issues/new?assignees=&labels=%E5%8F%8D%E9%A6%88%E9%97%AE%E9%A2%98&projects=&template=01-bugReport.yml
https://github.com/XIU2/Yuedu/issues/new?assignees=&labels=%E5%8F%8D%E9%A6%88%E9%97%AE%E9%A2%98&projects=&template=01-bugReport.yml&title=%E5%8F...
点击 功能建议 模板后面的 Get started 就是这样:
功能建议
https://github.com/XIU2/CloudflareSpeedTest/issues/new?assignees=&labels=%E5%8A%9F%E8%83%BD%E5%BB%BA%E8%AE%AE&projects=&template=02-featureRequest.yml
这些 Issues 模板文件位于项目根目录 .github/ISSUE_TEMPLATE 文件夹内,你可以参考我的模板文件改改,然后在你的项目根目录下创建这个文件夹,把模板文件放进去即可: https://github.com/XIU2/CloudflareSpeedTest/tree/master/.github/ISSUE_TEMPLATE https://github.com/XIU2/UserScript/tree/master/.github/ISSUE_TEMPLATE
当然,我这些模板都比较简单,其实还能添加一些进阶点的操作,比如加一些选择框什么的,具体你可以去搜一搜 Github Issues 模板格式写法示例啥的参考下。
像你要求的 Issues 前请检查类似 Issues 是否已经存在 可以直接在模板开头注明并引导,这样用户会更容易看到。
Issues 前请检查类似 Issues 是否已经存在
另外,对于 并设置 labels 为 enhancement、并设置 labels 为 bug。 这个其实用户是没有权限设置 labels 的,只有仓库管理员之类的才能设置,但是模板里是可以设置的,这样的话,用户选择模板创建 Issues 后默认就加上了 labels 。
并设置 labels 为 enhancement
并设置 labels 为 bug。
Issues标题 应该尽量简短精细,格式为:[功能建议]标题 这个模板里也可以设置预设标题,就像我的模板那样。
Issues标题 应该尽量简短精细,格式为:[功能建议]标题
Issues内容 建议直接复制以下格式进行修改。 Issues 模板就是专门干这个用的。
Issues内容 建议直接复制以下格式进行修改。
感谢建议,但即使是这样,大部分人也还会是老样子,而我也是随缘看issue👀
但从我十几个项目的上千个 Issues 来看,前后效果还是很明显的,至少很多人会认真填写,最起码标题格式、标签会整齐很多。
我当初也是在别的项目反馈问题时发现还有 Issues 模板这玩意,然后研究了下给我所有几乎项目都整上了。
刚才提了个 BUG 反馈的 Issues,看到了你置顶写的 BUG 反馈/功能建议 格式要求,但是很多 Issues 压根不遵守格式(可能没看到?也可能是嫌麻烦?或者说不懂这些?),建议你参考我的几个项目添加两个 Issues 模板来解决该问题(至少能大大减少)。
我几乎给我的所有项目都添加了 Issues 模板,我这些项目点击
[New Issues]
时出现的页面是这样:截图来自: https://github.com/XIU2/CloudflareSpeedTest/issues/new/choose
点击
反馈问题
模板后面的Get started
就是这样:https://github.com/XIU2/CloudflareSpeedTest/issues/new?assignees=&labels=%E5%8F%8D%E9%A6%88%E9%97%AE%E9%A2%98&projects=&template=01-bugReport.yml
https://github.com/XIU2/Yuedu/issues/new?assignees=&labels=%E5%8F%8D%E9%A6%88%E9%97%AE%E9%A2%98&projects=&template=01-bugReport.yml&title=%E5%8F...
点击
功能建议
模板后面的Get started
就是这样:https://github.com/XIU2/CloudflareSpeedTest/issues/new?assignees=&labels=%E5%8A%9F%E8%83%BD%E5%BB%BA%E8%AE%AE&projects=&template=02-featureRequest.yml
这些 Issues 模板文件位于项目根目录 .github/ISSUE_TEMPLATE 文件夹内,你可以参考我的模板文件改改,然后在你的项目根目录下创建这个文件夹,把模板文件放进去即可: https://github.com/XIU2/CloudflareSpeedTest/tree/master/.github/ISSUE_TEMPLATE https://github.com/XIU2/UserScript/tree/master/.github/ISSUE_TEMPLATE
当然,我这些模板都比较简单,其实还能添加一些进阶点的操作,比如加一些选择框什么的,具体你可以去搜一搜 Github Issues 模板格式写法示例啥的参考下。
像你要求的
Issues 前请检查类似 Issues 是否已经存在
可以直接在模板开头注明并引导,这样用户会更容易看到。另外,对于
并设置 labels 为 enhancement
、并设置 labels 为 bug。
这个其实用户是没有权限设置 labels 的,只有仓库管理员之类的才能设置,但是模板里是可以设置的,这样的话,用户选择模板创建 Issues 后默认就加上了 labels 。Issues标题 应该尽量简短精细,格式为:[功能建议]标题
这个模板里也可以设置预设标题,就像我的模板那样。Issues内容 建议直接复制以下格式进行修改。
Issues 模板就是专门干这个用的。