diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..161ff97 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,74 @@ +# Contributing to go-cqhttp + +想要成为 go-cqhttp 的 Contributor? Awesome! + +这个页面提供了一些 Tips ,可能对您的开发提供一些帮助. + +## 开发环境准备 + +go-cqhttp 使用了 `golangci-lint` 检查可能的问题,规范代码风格,为了减少不必要的麻烦, +我们推荐在开发环境中安装 `golangci-lint` 工具. + +```shell +go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest +``` + +在提交代码前运行 `golangci-lint` 检查你的代码: + +```shell +golangci-lint run +``` + +**注意**: `golangci-lint` 需要 `diff` 工具,在 windows 环境中,你可能需要使用 `Git Bash` 运行。 + +## Pull requests + +首先,为了方便项目管理,请将您的 PR 推送至**dev**分支。 + +### 检查 issue 列表 + +不管你是已经明确了要提交什么代码,还是正在寻找一个想法,你都应该先到 issue 列表看一下。 +如果在 issue 中找到了感兴趣的,请在 issue 表明正在对这个 issue 进行开发。 + +### 项目结构 + +下面是 go-cqhttp 项目结构的简单介绍. + +
coolq | ++ 包含与 MiraiGo 交互部分, CQ码解析等部分 + | +
server | ++ 包含 http,ws 通信的实现部分 + | +
global | +
+ 一个 |
+
docs | ++ 使用教程与文档 + | +