github.com/minio/mc@v0.0.0-20240503112107-b471de8d1882/CONTRIBUTING.md (about)

     1  ### Setup your mc Github Repository
     2  Fork [mc upstream](https://github.com/minio/mc/fork) source repository to your own personal repository.
     3  ```
     4  $ mkdir -p $GOPATH/src/github.com/minio
     5  $ cd $GOPATH/src/github.com/minio
     6  $ git clone https://github.com/$USER_ID/mc
     7  $ cd mc
     8  $ make
     9  $ ./mc --help
    10  ```
    11  
    12  ###  Developer Guidelines
    13  
    14  ``mc`` welcomes your contribution. To make the process as seamless as possible, we ask for the following:
    15  
    16  * Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes.
    17      - Fork it
    18      - Create your feature branch (git checkout -b my-new-feature)
    19      - Commit your changes (git commit -am 'Add some feature')
    20      - Push to the branch (git push origin my-new-feature)
    21      - Create new Pull Request
    22  
    23  * If you have additional dependencies for ``mc``, ``mc`` manages its dependencies using `go mod`
    24      - Run `go get foo/bar`
    25      - Edit your code to import foo/bar
    26      - Run `GO111MODULE=on go mod tidy` from top-level folder
    27  
    28  * When you're ready to create a pull request, be sure to:
    29      - Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
    30      - Run `go fmt`
    31      - Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request.
    32      - Make sure `make install` completes.
    33  
    34  * Read [Effective Go](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project
    35      - `mc` project is conformant with Golang style
    36      - if you happen to observe offending code, please feel free to send a pull request