Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (43 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

55 lines (43 loc) · 1.89 KB

Setup your Github Repository

Fork the s3git-go upstream repository to your own personal repository. Copy the URL and pass it to the go get command. Go uses git to clone a copy into your project workspace folder.

$ mkdir -p $GOPATH/src/github.com/s3git-go
$ cd $GOPATH/src/github.com/s3git-go
$ git clone https://github.com/$USER_ID/s3git-go
$ cd s3git-go

Compiling from source

Run go build to build the library.

$ go build

Setting up git remote as upstream

$ cd $GOPATH/src/github.com/s3git/s3git-go
$ git remote add upstream https://github.com/s3git/s3git-go
$ git fetch upstream
$ git merge upstream/master
...
...
$ go build

Developer Guidelines

s3git community welcomes your contribution. To make the process as seamless as possible, we ask for the following:

  • Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes.

    • Fork it
    • Create your feature branch (git checkout -b my-new-feature)
    • Commit your changes (git commit -am 'Add some feature')
    • Push to the branch (git push origin my-new-feature)
    • Create new Pull Request

  • When you're ready to create a pull request, be sure to:

    • Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
    • Run go test
    • Squash your commits into a single commit. git rebase -i. It's okay to force update your pull request.
    • Make sure go test -race ./... and go build completes.

  • Read Effective Go article from Golang project

    • s3git-go project is fully conformant with Golang style
    • if you happen to observe offending code, please feel free to send a pull request