github.com/minio/madmin-go/v2@v2.2.1/CONTRIBUTING.md (about)

     1  
     2  ###  Developer Guidelines
     3  
     4  ``madmin-go`` welcomes your contribution. To make the process as seamless as possible, we ask for the following:
     5  
     6  * Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes.
     7      - Fork it
     8      - Create your feature branch (git checkout -b my-new-feature)
     9      - Commit your changes (git commit -am 'Add some feature')
    10      - Push to the branch (git push origin my-new-feature)
    11      - Create new Pull Request
    12  
    13  * When you're ready to create a pull request, be sure to:
    14      - Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
    15      - Run `go fmt`
    16      - Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request.
    17      - Make sure `go test -race ./...` and `go build` completes.
    18        NOTE: go test runs functional tests and requires you to have a AWS S3 account. Set them as environment variables
    19        ``ACCESS_KEY`` and ``SECRET_KEY``. To run shorter version of the tests please use ``go test -short -race ./...``
    20  
    21  * Read [Effective Go](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project
    22      - `madmin-go` project is strictly conformant with Golang style
    23      - if you happen to observe offending code, please feel free to send a pull request