chore: 拆分 issue template 方便自动添加 labels
This commit is contained in:
parent
41ce374ea1
commit
8a355f4247
@ -1,19 +1,21 @@
|
||||
name: "新增/更新请求"
|
||||
description: "请求添加/补充/更新文档中的 API 定义"
|
||||
title: "[新增/更新请求] <title>"
|
||||
name: "新增请求"
|
||||
description: "请求添加文档中未收录的 API 定义"
|
||||
title: "[新增请求] <title>"
|
||||
labels: ["新增/Add"]
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: reminders
|
||||
attributes:
|
||||
label: "提交前请确认"
|
||||
options:
|
||||
- label: "我已检索仓库中文档,不包含所提及内容,或所提及内容在本仓库中存在错误,且 Issues、Pull Requests 中无相关提交"
|
||||
- label: "我已检索仓库中文档,确认不包含所提及内容,且 Issues、Pull Requests 中无相关提交"
|
||||
required: true
|
||||
- type: dropdown
|
||||
id: source
|
||||
attributes:
|
||||
label: "API 来源"
|
||||
description: "该 API 在何平台中使用"
|
||||
multiple: true
|
||||
options:
|
||||
- "Web 端(含 h5)"
|
||||
- "PC 客户端(Electron)"
|
||||
@ -38,17 +40,17 @@ body:
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: adderss
|
||||
id: address
|
||||
attributes:
|
||||
label: "API 地址"
|
||||
description: "REST 的 url,或 gRPC 的包名+服务名,更新时可为原文档链接"
|
||||
description: "REST 的 url,或 gRPC 的包名+服务名"
|
||||
placeholder: "eg: https://api.bilibili.com/2333333"
|
||||
validations:
|
||||
required: false
|
||||
required: true
|
||||
- type: textarea
|
||||
id: details
|
||||
attributes:
|
||||
label: "详情描述"
|
||||
description: "新增时请描述该 API 的使用场景、请求及响应字段等,可附上原始抓包记录;更新时请指出原文档中与最新 API 行为不符之处,并附上已知的最新改动"
|
||||
description: "请描述该 API 的使用场景、请求及响应字段等,可附上原始抓包记录"
|
||||
validations:
|
||||
required: true
|
||||
required: true
|
||||
27
.github/ISSUE_TEMPLATE/2-update-request.yml
vendored
Normal file
27
.github/ISSUE_TEMPLATE/2-update-request.yml
vendored
Normal file
@ -0,0 +1,27 @@
|
||||
name: "更新请求"
|
||||
description: "请求补充或更新文档中已有的 API 定义"
|
||||
title: "[更新请求] <title>"
|
||||
labels: ["更新/Update"]
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: reminders
|
||||
attributes:
|
||||
label: "提交前请确认"
|
||||
options:
|
||||
- label: "我已确认文档中相关内容存在错误或不足,且 Issues、Pull Requests 中无相关提交"
|
||||
required: true
|
||||
- type: input
|
||||
id: document_link
|
||||
attributes:
|
||||
label: "原文档链接"
|
||||
description: "需要更新的文档链接,指定到具体 API"
|
||||
placeholder: "eg: https://github.com/SocialSisterYi/bilibili-API-collect/blob/master/docs/bangumi/info.md#获取剧集明细web端ssidepid方式 or https://socialsisteryi.github.io/bilibili-API-collect/docs/bangumi/info.html#获取剧集明细-web端-ssid-epid方式"
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: details
|
||||
attributes:
|
||||
label: "更新内容"
|
||||
description: "请指出原文档中与最新 API 行为不符之处,并附上已知的最新改动和验证信息"
|
||||
validations:
|
||||
required: true
|
||||
62
.github/ISSUE_TEMPLATE/3-mistake-report.yml
vendored
Normal file
62
.github/ISSUE_TEMPLATE/3-mistake-report.yml
vendored
Normal file
@ -0,0 +1,62 @@
|
||||
name: "错误修正"
|
||||
description: "发现文档内容有误并提交修正请求"
|
||||
title: "[错误修正] <标题>"
|
||||
labels: ["错误/Mistakes"]
|
||||
body:
|
||||
- type: checkboxes
|
||||
id: confirmations
|
||||
attributes:
|
||||
label: "提交前请确认"
|
||||
options:
|
||||
- label: "我已确认文档中的错误存在,且 Issues、Pull Requests 中无相同修正"
|
||||
required: true
|
||||
- label: "我已验证修正内容的正确性"
|
||||
required: false
|
||||
|
||||
- type: input
|
||||
id: document_link
|
||||
attributes:
|
||||
label: "错误所在文档链接"
|
||||
description: "需要修正的文档链接,指定到具体 API"
|
||||
placeholder: "eg: https://github.com/SocialSisterYi/bilibili-API-collect/blob/master/docs/bangumi/info.md#获取剧集明细web端ssidepid方式 or https://socialsisteryi.github.io/bilibili-API-collect/docs/bangumi/info.html#获取剧集明细-web端-ssid-epid方式"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: error_type
|
||||
attributes:
|
||||
label: "错误类型"
|
||||
multiple: true
|
||||
options:
|
||||
- "API 地址/鉴权方式错误"
|
||||
- "参数错误"
|
||||
- "响应数据结构或响应示例错误"
|
||||
- "描述性内容错误(如拼写/流程说明)"
|
||||
- "接口已弃用下线"
|
||||
- "其他(请在下文说明)"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: error_description
|
||||
attributes:
|
||||
label: "错误描述"
|
||||
description: "请详细说明具体错误所在,如有多个错误请编号列出"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: evidence
|
||||
attributes:
|
||||
label: "纠错依据"
|
||||
description: "如果有,请提供抓包记录等佐证,方便确认。如果有多个错误,请将依据对应错误描述的编号列出"
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: correction
|
||||
attributes:
|
||||
label: "修正方案"
|
||||
description: "如果可以,请提供修正后的内容,如有多个修正点请编号列出"
|
||||
validations:
|
||||
required: false
|
||||
Loading…
Reference in New Issue
Block a user