返回提交历史
Modified
.vuepress/config.js
+4
-3
Modified
CONTRIBUTING.md
+37
-19
XFEstudio/bilibili-API-collect
Update CONTRIBUTING Guide
edb7208
代码差异
2 个文件
+41
-22
@@ -24,20 +24,21 @@ export default defineUserConfig({
24
24
text: "相关社群",
25
25
children: [
26
26
{
27
text: "QQ交流群",
27
text: "QQ交流群（综合技术交流）",
28
28
link: "http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=2rRJXK3zgU5yi3e_4rNLeJYUjMLzw_Jj&authKey=L%2FN3EfZXo3QFjEuHq4ifTgh%2F384UmrYpjl7dbYPhYHtznhfJWxkymxQKObQunmEQ&noverify=0&group_code=560304737",
29
29
},
30
30
{
31
text: "Telegram交流群",
31
text: "Telegram交流群（Github Bot推送）",
32
32
link: "https://t.me/bilibili_API_collect_community",
33
33
},
34
34
],
35
35
},
36
36
],
37
37
sidebar: "auto",
38
repo: "SocialSisterYi/bilibili-API-collect",
38
repo: "https://github.com/SocialSisterYi/bilibili-API-collect",
39
39
docsBranch: "master",
40
40
editLinkText: "在 GitHub 上编辑此页",
41
colorMode: "auto"
41
42
}),
42
43
plugins: [copyCodePlugin({}), searchPlugin({})],
43
44
markdown: {
@@ -10,6 +10,43 @@
10
10
11
11
本项目收集的接口类型包括但不限于 REST API、gRPC、WebSocket，文档内统一优先使用安全套接字协议，如`https`、`securityRpc`、`wss`。
12
12
13
## Issue与社群讨论
14
15
对文档内容存在**不理解**之处、以及发现文档内容有所**缺失**或**错误**，可直接提出，强烈建议以发 **Issue** 的形式参与用户反馈，并希望关于本项目的各种交流都是**公开进行**的，因为这样才可以保证关键信息的一致性。
16
17
由于本项目属于文档型项目，故不设置 Issue 模板，同时允许中英文标题，但提交 Issue 请遵守以下原则：
18
19
1. 标题言简意骇，说明欲提出的问题要点，如`如何通过xx接口获取yy`、`xx接口地址已失效`、`关于xx字段意义的探讨`、` 建议将xx加入yy分类`等标题；切勿使用表意含糊不清或索取性的标题，如`怎么解决风控`、`补充`、`搜索的接口是什么`、`好兄弟有没有投稿的接口`等标题
20
2. Issue 正文应对问题进行尽可能详细的描述，展开并聚焦有关的信息，例如：“在前端页面某地址 / APP 某界面会访问某 API（标明地址），它的某参数与文档中不符（标明文档地址）”
21
3. 提出问题时注意 [提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md) 并且 [别像弱智一样提问](https://github.com/tangx/Stop-Ask-Questions-The-Stupid-Ways)
22
23
同时，您还可以通过加入社群的方式参与讨论
24
25
- QQ 交流群：[邀请链接](https://jq.qq.com/?_wv=1027&k=s1M0LCcu)
26
- Telegram 交流群：[@bilibili_API_collect_community](https://t.me/bilibili_API_collect_community)
27
28
::: tip ✅提示
29
30
QQ 交流群为综合技术交流群（兼 Owner 的粉丝群），可交流探讨任何技术，包括但不限于 [BAC 项目](https://github.com/SocialSisterYi/bilibili-API-collect)
31
32
Telegram 交流群主要用作 [BAC 项目](https://github.com/SocialSisterYi/bilibili-API-collect) 的 Github Bot 接收，也可以进行项目相关的讨论，但不建议在此讨论交流其他内容（公开群）
33
34
:::
35
36
::: warning ⚠️注意
37
38
群内讨论同样需要遵守**公开交流**的原则，以及群内会定期清理不活跃成员。
39
40
**QQ 交流群** 的加群问题答案可以去 [Owner 的主页](https://github.com/SocialSisterYi) Contact 部分找到，如果您填写“我不知道，从 Github 来的“那么管理员将有理由禁止您进群讨论！
41
42
:::
43
44
::: danger 🈲禁止
45
46
项目 Issue 及其相关社群中 **禁止** 询问讨论 风控解除、爬虫（采集）、破解、漏洞利用、买卖代码和账号 相关内容，抵制基于本项目进行的一切黑产行为！
47
48
:::
49
13
50
## 目录与路径结构
14
51
15
52
### 目录
@@ -214,22 +251,3 @@ message Author {
214
251
## 文档提交
215
252
216
253
TODO
217
218
## Issue与社群讨论
219
220
对文档内容存在**不理解**之处、以及发现文档内容有所**缺失**或**错误**，可直接提出，强烈建议以发 **Issue** 的形式参与用户反馈，并希望关于本项目的各种交流都是**公开进行**的，因为这样才可以保证关键信息的一致性。
221
222
由于本项目属于文档型项目，故不设置 Issue 模板，同时允许中英文标题，但提交 Issue 请遵守以下原则：
223
224
1. 标题言简意骇，说明欲提出的问题要点，如`如何通过xx接口获取yy`、`xx接口地址已失效`、`关于xx字段意义的探讨`、` 建议将xx加入yy分类`等标题；切勿使用表意含糊不清或索取性的标题，如`怎么解决风控`、`补充`、`搜索的接口是什么`、`好兄弟有没有投稿的接口`等标题
225
2. Issue 正文应对问题进行尽可能详细的描述，展开并聚焦有关的信息，例如：“在前端页面某地址 / APP 某界面会访问某 API（标明地址），它的某参数与文档中不符（标明文档地址）”
226
3. 提出问题时注意 [提问的智慧](https://github.com/ryanhanwu/How-To-Ask-Questions-The-Smart-Way/blob/main/README-zh_CN.md) 并且 [别像弱智一样提问](https://github.com/tangx/Stop-Ask-Questions-The-Stupid-Ways)
227
228
同时，你还可以通过加入社群的方式参与讨论（包括但不限于本项目
229
230
- QQ 交流群：[邀请链接](https://jq.qq.com/?_wv=1027&k=s1M0LCcu)
231
232
- Telegram 交流群：[@bilibili_API_collect_community](https://t.me/bilibili_API_collect_community)
233
234
注意：群内讨论同样需要遵守**公开交流**的原则，以及群内会定期清理不活跃成员
235