Update CONTRIBUTING Guide
This commit is contained in:
parent
9611ac77c2
commit
edb7208543
@ -24,20 +24,21 @@ export default defineUserConfig({
|
|||||||
text: "相关社群",
|
text: "相关社群",
|
||||||
children: [
|
children: [
|
||||||
{
|
{
|
||||||
text: "QQ交流群",
|
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=2rRJXK3zgU5yi3e_4rNLeJYUjMLzw_Jj&authKey=L%2FN3EfZXo3QFjEuHq4ifTgh%2F384UmrYpjl7dbYPhYHtznhfJWxkymxQKObQunmEQ&noverify=0&group_code=560304737",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
text: "Telegram交流群",
|
text: "Telegram交流群(Github Bot推送)",
|
||||||
link: "https://t.me/bilibili_API_collect_community",
|
link: "https://t.me/bilibili_API_collect_community",
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
sidebar: "auto",
|
sidebar: "auto",
|
||||||
repo: "SocialSisterYi/bilibili-API-collect",
|
repo: "https://github.com/SocialSisterYi/bilibili-API-collect",
|
||||||
docsBranch: "master",
|
docsBranch: "master",
|
||||||
editLinkText: "在 GitHub 上编辑此页",
|
editLinkText: "在 GitHub 上编辑此页",
|
||||||
|
colorMode: "auto"
|
||||||
}),
|
}),
|
||||||
plugins: [copyCodePlugin({}), searchPlugin({})],
|
plugins: [copyCodePlugin({}), searchPlugin({})],
|
||||||
markdown: {
|
markdown: {
|
||||||
|
|||||||
@ -10,6 +10,43 @@
|
|||||||
|
|
||||||
本项目收集的接口类型包括但不限于 REST API、gRPC、WebSocket,文档内统一优先使用安全套接字协议,如`https`、`securityRpc`、`wss`。
|
本项目收集的接口类型包括但不限于 REST API、gRPC、WebSocket,文档内统一优先使用安全套接字协议,如`https`、`securityRpc`、`wss`。
|
||||||
|
|
||||||
|
## Issue与社群讨论
|
||||||
|
|
||||||
|
对文档内容存在**不理解**之处、以及发现文档内容有所**缺失**或**错误**,可直接提出,强烈建议以发 **Issue** 的形式参与用户反馈,并希望关于本项目的各种交流都是**公开进行**的,因为这样才可以保证关键信息的一致性。
|
||||||
|
|
||||||
|
由于本项目属于文档型项目,故不设置 Issue 模板,同时允许中英文标题,但提交 Issue 请遵守以下原则:
|
||||||
|
|
||||||
|
1. 标题言简意骇,说明欲提出的问题要点,如`如何通过xx接口获取yy`、`xx接口地址已失效`、`关于xx字段意义的探讨`、` 建议将xx加入yy分类`等标题;切勿使用表意含糊不清或索取性的标题,如`怎么解决风控`、`补充`、`搜索的接口是什么`、`好兄弟有没有投稿的接口`等标题
|
||||||
|
2. Issue 正文应对问题进行尽可能详细的描述,展开并聚焦有关的信息,例如:“在前端页面某地址 / APP 某界面会访问某 API(标明地址),它的某参数与文档中不符(标明文档地址)”
|
||||||
|
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)
|
||||||
|
|
||||||
|
同时,您还可以通过加入社群的方式参与讨论
|
||||||
|
|
||||||
|
- QQ 交流群:[邀请链接](https://jq.qq.com/?_wv=1027&k=s1M0LCcu)
|
||||||
|
- Telegram 交流群:[@bilibili_API_collect_community](https://t.me/bilibili_API_collect_community)
|
||||||
|
|
||||||
|
::: tip ✅提示
|
||||||
|
|
||||||
|
QQ 交流群为综合技术交流群(兼 Owner 的粉丝群),可交流探讨任何技术,包括但不限于 [BAC 项目](https://github.com/SocialSisterYi/bilibili-API-collect)
|
||||||
|
|
||||||
|
Telegram 交流群主要用作 [BAC 项目](https://github.com/SocialSisterYi/bilibili-API-collect) 的 Github Bot 接收,也可以进行项目相关的讨论,但不建议在此讨论交流其他内容(公开群)
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
::: warning ⚠️注意
|
||||||
|
|
||||||
|
群内讨论同样需要遵守**公开交流**的原则,以及群内会定期清理不活跃成员。
|
||||||
|
|
||||||
|
**QQ 交流群** 的加群问题答案可以去 [Owner 的主页](https://github.com/SocialSisterYi) Contact 部分找到,如果您填写“我不知道,从 Github 来的“那么管理员将有理由禁止您进群讨论!
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
|
::: danger 🈲禁止
|
||||||
|
|
||||||
|
项目 Issue 及其相关社群中 **禁止** 询问讨论 风控解除、爬虫(采集)、破解、漏洞利用、买卖代码和账号 相关内容,抵制基于本项目进行的一切黑产行为!
|
||||||
|
|
||||||
|
:::
|
||||||
|
|
||||||
## 目录与路径结构
|
## 目录与路径结构
|
||||||
|
|
||||||
### 目录
|
### 目录
|
||||||
@ -214,22 +251,3 @@ message Author {
|
|||||||
## 文档提交
|
## 文档提交
|
||||||
|
|
||||||
TODO
|
TODO
|
||||||
|
|
||||||
## Issue与社群讨论
|
|
||||||
|
|
||||||
对文档内容存在**不理解**之处、以及发现文档内容有所**缺失**或**错误**,可直接提出,强烈建议以发 **Issue** 的形式参与用户反馈,并希望关于本项目的各种交流都是**公开进行**的,因为这样才可以保证关键信息的一致性。
|
|
||||||
|
|
||||||
由于本项目属于文档型项目,故不设置 Issue 模板,同时允许中英文标题,但提交 Issue 请遵守以下原则:
|
|
||||||
|
|
||||||
1. 标题言简意骇,说明欲提出的问题要点,如`如何通过xx接口获取yy`、`xx接口地址已失效`、`关于xx字段意义的探讨`、` 建议将xx加入yy分类`等标题;切勿使用表意含糊不清或索取性的标题,如`怎么解决风控`、`补充`、`搜索的接口是什么`、`好兄弟有没有投稿的接口`等标题
|
|
||||||
2. Issue 正文应对问题进行尽可能详细的描述,展开并聚焦有关的信息,例如:“在前端页面某地址 / APP 某界面会访问某 API(标明地址),它的某参数与文档中不符(标明文档地址)”
|
|
||||||
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)
|
|
||||||
|
|
||||||
同时,你还可以通过加入社群的方式参与讨论(包括但不限于本项目
|
|
||||||
|
|
||||||
- QQ 交流群:[邀请链接](https://jq.qq.com/?_wv=1027&k=s1M0LCcu)
|
|
||||||
|
|
||||||
- Telegram 交流群:[@bilibili_API_collect_community](https://t.me/bilibili_API_collect_community)
|
|
||||||
|
|
||||||
注意:群内讨论同样需要遵守**公开交流**的原则,以及群内会定期清理不活跃成员
|
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user