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

     1  # Contributing
     2  
     3  If you want to contribute, but not sure what to do, here's a list of things that I always need help with:
     4  
     5  * Translations
     6      * README.md
     7      * [docs](https://github.com/GoAdminGroup/docs/issues/1)
     8  * Bug-hunting
     9  * Finding security problems
    10  * Themes and Plugins
    11  
    12  See [manual](https://github.com/kotovmak/go-admin/projects/3) for more information.
    13  
    14  You can view all open issues on github, which is usually a good starting point if you want to start contributing:
    15  
    16  https://github.com/search?q=org%3AGoAdminGroup+is%3Aopen+is%3Aissue+archived%3Afalse&type=Issues
    17  
    18  ## how to
    19  
    20  GoAdmin uses GitHub to manage reviews of pull requests:
    21  
    22  - If you have a trivial fix or improvement, go ahead and create a pull request.
    23  - If you plan to do something more involved, discuss your ideas on the relevant GitHub issue.
    24  
    25  For now, you need to add your fork as a remote on the original **\$GOPATH**/src/github.com/GoAdminGroup/go-admin clone, so:
    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  And before you commit, remember to execute the command: 
    36  
    37  ```
    38  make test
    39  ```
    40  
    41  See the Makefile for more details.
    42  
    43  Notice: `go get` return `package github.com/GoAdminGroup/go-admin: no Go files in /go/src/github.com/GoAdminGroup/go-admin` is normal.
    44  
    45  ### Dependency management
    46  
    47  We uses [Go modules](https://golang.org/cmd/go/#hdr-Modules__module_versions__and_more) to manage dependencies on external packages.
    48  This requires a working Go environment with version 1.13 or greater and git installed.
    49  
    50  To add or update a new dependency, use the `go get` command:
    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  Tidy up the `go.mod` and `go.sum` files:
    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  You have to commit the changes to `go.mod` and `go.sum` before submitting the pull request.
    70  
    71  # Support
    72  
    73  You can also donate or become a patreon, which helps out covering server costs and potentially make it possible to put out bounties:
    74  
    75  * **Support on [Open Collective](https://opencollective.com/go-admin)**
    76  * Donate via [PayPal](https://paypal.me/cg80333)
    77  
    78  # Members
    79  
    80  If you are a member of the official GoAdmin developer Team:
    81  
    82  * [Discussions](http://forum.go-admin.cn)
    83  * [Tasks](https://github.com/kotovmak/go-admin/projects)
    84  * [Chat](https://t.me/joinchat/NlyH6Bch2QARZkArithKvg)