github.com/kotovmak/go-admin@v1.1.1/CONTRIBUTING_CN.md (about)

     1  # 贡献
     2  
     3  如果你想要对项目作出贡献，却不知道怎么做，下面有一些帮助：
     4  
     5  * 翻译
     6      * README.md
     7      * [docs](https://github.com/GoAdminGroup/docs/issues/1)
     8  * 寻找BUG
     9  * 寻找安全问题
    10  * 主题和插件
    11  
    12  在这里：[功能规划](https://github.com/kotovmak/go-admin/projects/3) 可以获得更多信息。
    13  
    14  你也可以看一下所有开放的issues，从这里去入手：
    15  
    16  https://github.com/search?q=org%3AGoAdminGroup+is%3Aopen+is%3Aissue+archived%3Afalse&type=Issues
    17  
    18  ## 如何做贡献
    19  
    20  GoAdmin 使用 GitHub 来管理项目代码：
    21  
    22  - 如果你发现一些微不足道的fix或者功能增加，直接提pr即可；
    23  - 如果你有一些提议，那么你可以先开一个issue进行讨论；
    24  
    25  然后，你需要fork远程的master分支到你本地 **\$GOPATH**/src/github.com/GoAdminGroup/go-admin ：
    26  
    27  ```bash
    28  
    29  $ go get github.com/GoAdminGroup/go-admin
    30  $ cd $GOPATH/src/github.com/GoAdminGroup/go-admin # GOPATH is $HOME/go by default.
    31  
    32  $ git remote add <FORK_NAME> <FORK_URL>
    33  ```
    34  
    35  在你提交代码之前，记得执行下面这个命令： 
    36  
    37  ```
    38  make test
    39  ```
    40  
    41  看根目录下的```Makefile```获得更多信息。
    42  
    43  注意了： `go get` 返回 `package github.com/GoAdminGroup/go-admin: no Go files in /go/src/github.com/GoAdminGroup/go-admin` 是正常的。
    44  
    45  ### 依赖管理
    46  
    47  我们使用 [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) 来管理依赖。
    48  这需要 golang 版本大于1.11，以及安装了 git
    49  
    50  要增加或更新依赖，就使用 `go get` 命令：
    51  
    52  ```bash
    53  # Pick the latest tagged release.
    54  go get example.com/some/module/pkg
    55  
    56  # Pick a specific version.
    57  go get example.com/some/module/pkg@vX.Y.Z
    58  ```
    59  
    60  整理好 `go.mod` 和 `go.sum`：
    61  
    62  ```bash
    63  go mod tidy
    64  go mod vendor
    65  git add go.mod go.sum vendor
    66  git commit
    67  ```
    68  
    69  直接提交 `go.mod` and `go.sum` 的修改。
    70  
    71  # 赞助
    72  
    73  你可以捐助或参与众筹来帮助我们维护服务器费用，以及提供一些奖金资助项目发展。
    74  
    75  * **Support on [Open Collective](https://opencollective.com/go-admin)**
    76  * Donate via [PayPal](https://paypal.me/cg80333)
    77  
    78  # 成员
    79  
    80  如果你已经是GoAdmin的官方开发组成员：
    81  
    82  * [Discussions](http://forum.go-admin.cn)
    83  * [Tasks](https://github.com/kotovmak/go-admin/projects)
    84  * [Chat](https://t.me/joinchat/NlyH6Bch2QARZkArithKvg)