Skip to content

Commit f020436

Browse files
committed
add CONTRIBUTING.md
添加贡献指南
1 parent b273a4f commit f020436

File tree

2 files changed

+76
-0
lines changed

2 files changed

+76
-0
lines changed

CONTRIBUTING.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributing to go-cqhttp
2+
3+
想要成为 go-cqhttp 的 Contributor? Awesome!
4+
5+
这个页面提供了一些 Tips ,可能对您的开发提供一些帮助.
6+
7+
## 开发环境准备
8+
9+
go-cqhttp 使用了 `golangci-lint` 检查可能的问题,规范代码风格,为了减少不必要的麻烦,
10+
我们推荐在开发环境中安装 `golangci-lint` 工具.
11+
12+
```shell
13+
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
14+
```
15+
16+
在提交代码前运行 `golangci-lint` 检查你的代码:
17+
18+
```shell
19+
golangci-lint run
20+
```
21+
22+
**注意**: `golangci-lint` 需要 `diff` 工具,在 windows 环境中,你可能需要使用 `Git Bash` 运行。
23+
24+
## Pull requests
25+
26+
首先,为了方便项目管理,请将您的 PR 推送至**dev**分支。
27+
28+
### 检查 issue 列表
29+
30+
不管你是已经明确了要提交什么代码,还是正在寻找一个想法,你都应该先到 issue 列表看一下。
31+
如果在 issue 中找到了感兴趣的,请在 issue 表明正在对这个 issue 进行开发。
32+
33+
### 项目结构
34+
35+
下面是 go-cqhttp 项目结构的简单介绍.
36+
37+
<table class="tg">
38+
<tr>
39+
<td>coolq</td>
40+
<td>
41+
包含与 MiraiGo 交互部分, CQ码解析等部分
42+
</td>
43+
</tr>
44+
<tr>
45+
<td>server</td>
46+
<td>
47+
包含 http,ws 通信的实现部分
48+
</td>
49+
</tr>
50+
<tr>
51+
<td>global</td>
52+
<td>
53+
一个<del>实用的</del>工具包
54+
</td>
55+
</tr>
56+
<tr>
57+
<td>docs</td>
58+
<td>
59+
使用教程与文档
60+
</td>
61+
</tr>
62+
</table>
63+
64+
## 社区准则
65+
为了让社区保持强大,不断发展,我们向整个社区提出了一些通用准则:
66+
67+
**友善**:对社区成员要礼貌,尊重和礼貌。 请不要在社区中发布任何有关种族歧视、性别歧视、
68+
地域歧视、人格侮辱等言论。
69+
70+
**鼓励参与**:在社区中讲礼貌的每个人都受到欢迎,无论他们的贡献程度如何,
71+
我们鼓励一切人参与(不一定需要提交代码) `go-cqhttp` 的开发。
72+
73+
**紧贴主题**:请避免主题外的讨论。当您更新或回复时, 可能会给大量人员发送邮件,
74+
请牢记,没有人喜欢垃圾邮件。

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ _✨ 基于 [Mirai](https://github.com/mamoe/mirai) 以及 [MiraiGo](https://git
3636
<a href="https://github.com/Mrs4s/go-cqhttp/releases">下载</a>
3737
·
3838
<a href="https://docs.go-cqhttp.org/guide/quick_start.html">开始使用</a>
39+
·
40+
<a href="https://github.com/Mrs4s/go-cqhttp/blob/master/CONTRIBUTING.md">参与贡献</a>
3941
</p>
4042

4143

0 commit comments

Comments
 (0)