From 5fcc6e3a772c9049ed87d813955a064348069c7b Mon Sep 17 00:00:00 2001 From: SocialSisterYi <1440239038@qq.com> Date: Sat, 20 Apr 2024 20:47:22 +0800 Subject: [PATCH] add issue template --- .github/ISSUE_TEMPLATE /1-update-request.yml | 54 ++++++++++++++++++++ .vuepress/config.js | 2 +- README.md | 2 +- 3 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE /1-update-request.yml diff --git a/.github/ISSUE_TEMPLATE /1-update-request.yml b/.github/ISSUE_TEMPLATE /1-update-request.yml new file mode 100644 index 0000000..d0cb0ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE /1-update-request.yml @@ -0,0 +1,54 @@ +name: "新增/更新请求" +description: "请求添加/补充/更新文档中的 API 定义" +title: "[新增/更新请求] " +body: + - type: checkboxes + id: reminders + attributes: + description: "提交前请确认" + options: + label: "我已检索仓库中文档,不包含所提及内容,或所提及内容在本仓库中存在错误,且 Issues、Pull Requests 中无相关提交" + required: true + - type: dropdown + id: source + attributes: + label: "API 来源" + description: "该 API 在何平台中使用" + options: + - label: "Web 端(含 h5)" + - label: "PC 客户端(Electron)" + - label: "Android 客户端(含粉版、平板版、蓝版、概念版、国际版等)" + - label: "TV 客户端(含云试听小电视、车机、物联网版等)" + - label: "IOS 客户端(含粉版、平板版、概念版等)" + - label: "必剪客户端" + - label: "漫画客户端" + - label: "其他(请在详情中备注)" + validations: + required: true + - type: dropdown + id: type + attributes: + label: "API 类型" + description: "API 所使用的协议标准及调用方式" + options: + - label: "REST" + - label: "gRPC" + - label: "长连接数据帧(含 ws、TCP)" + - label: "其他类型(请在详情中备注)" + validations: + required: true + - type: input + id: adderss + attributes: + label: "API 地址" + description: "REST 的 url,或 gRPC 的包名+服务名,更新时可为原文档链接" + placeholder: "eg: https://api.bilibili.com/2333333" + validations: + required: false + - type: textarea + id: details + attributes: + label: "详情描述" + description: "新增时请描述该 API 的使用场景、请求及响应字段等,可附上原始抓包记录;更新时请指出原文档中与最新 API 行为不符之处,并附上已知的最新改动" + validations: + required: true diff --git a/.vuepress/config.js b/.vuepress/config.js index 48c1dd2..99b7f2e 100644 --- a/.vuepress/config.js +++ b/.vuepress/config.js @@ -25,7 +25,7 @@ export default defineUserConfig({ children: [ { text: "QQ交流群(综合技术交流)", - link: "http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=2rRJXK3zgU5yi3e_4rNLeJYUjMLzw_Jj&authKey=L%2FN3EfZXo3QFjEuHq4ifTgh%2F384UmrYpjl7dbYPhYHtznhfJWxkymxQKObQunmEQ&noverify=0&group_code=560304737", + link: "http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=ympvb3LAPT-Ulu3ezhGqbkJ8zXMKImOX&authKey=z1KdkOdKO3wytN43m9K6On9nBtnDL4pAoD6VQHCipFBb9TasNDKuDHCmOE6TF3uc&noverify=0&group_code=191187164", }, { text: "Telegram交流群(Github Bot推送)", diff --git a/README.md b/README.md index a169926..1f39259 100644 --- a/README.md +++ b/README.md @@ -296,7 +296,7 @@ protobuf 序列格式:[传送门](https://www.jianshu.com/p/a24c88c0526a ) ⚠注意:开源社群欢迎交流探讨,**拒绝**咨询、**不支持**合作,**黑产号**一经发现立即拉黑并举报相关 SRC -- QQ 交流群:[邀请链接](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=2rRJXK3zgU5yi3e_4rNLeJYUjMLzw_Jj&authKey=L%2FN3EfZXo3QFjEuHq4ifTgh%2F384UmrYpjl7dbYPhYHtznhfJWxkymxQKObQunmEQ&noverify=0&group_code=560304737) +- QQ 交流群:[邀请链接](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=ympvb3LAPT-Ulu3ezhGqbkJ8zXMKImOX&authKey=z1KdkOdKO3wytN43m9K6On9nBtnDL4pAoD6VQHCipFBb9TasNDKuDHCmOE6TF3uc&noverify=0&group_code=191187164) - Telegram 交流群:[@bilibili_API_collect_community](https://t.me/bilibili_API_collect_community) ## 🧋发电