From a56f7e2f231fea9ad5a20e47e38a687c45cda56f Mon Sep 17 00:00:00 2001 From: Nitish Tiwari Date: Mon, 18 Sep 2017 23:32:45 +0530 Subject: [PATCH] Refactor CONTRIBUTING.md to make it more reader friendly (#4918) --- CONTRIBUTING.md | 98 ++++++++++++++++++++++++------------------------- 1 file changed, 49 insertions(+), 49 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b7e9ee23b..3d0b0aef6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,14 @@ -### Install Golang +# Minio Contribution Guide [![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io) [![Go Report Card](https://goreportcard.com/badge/minio/minio)](https://goreportcard.com/report/minio/minio) [![Docker Pulls](https://img.shields.io/docker/pulls/minio/minio.svg?maxAge=604800)](https://hub.docker.com/r/minio/minio/) [![codecov](https://codecov.io/gh/minio/minio/branch/master/graph/badge.svg)](https://codecov.io/gh/minio/minio) -If you do not have a working Golang environment setup please follow [Golang Installation Guide](https://docs.minio.io/docs/how-to-install-golang). +``Minio`` community welcomes your contribution. To make the process as seamless as possible, we recommend you read this contribution guide. + +## Development Workflow + +Start by forking the Minio GitHub repository, make changes in a branch and then send a pull request. We encourage pull requests to discuss code changes. Here are the steps in details: ### Setup your Minio Github Repository -Fork [Minio upstream](https://github.com/minio/minio/fork) source repository to your own personal repository. Copy the URL for minio from your personal github repo (you will need it for the `git clone` command below). +Fork [Minio upstream](https://github.com/minio/minio/fork) source repository to your own personal repository. Copy the URL of your Minio fork (you will need it for the `git clone` command below). + ```sh $ mkdir -p $GOPATH/src/github.com/minio $ cd $GOPATH/src/github.com/minio @@ -11,61 +16,56 @@ $ git clone $ cd minio ``` -### Compiling Minio from source -Minio uses ``Makefile`` to wrap around some of redundant checks done through command line. - -```sh -$ make -Checking if proper environment variables are set.. Done -... -Checking dependencies for Minio.. Done -Installed govet -Building Libraries -... -... -``` - -### Setting up git remote as ``upstream`` +### Set up git remote as ``upstream`` ```sh $ cd $GOPATH/src/github.com/minio/minio $ git remote add upstream https://github.com/minio/minio $ git fetch upstream $ git merge upstream/master ... -... -$ make -Checking if proper environment variables are set.. Done -... -Checking dependencies for Minio.. Done -Installed govet -Building Libraries -... ``` -### Developer Guidelines -``Minio`` 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 +### Create your feature branch +Before making code changes, make sure you create a separate branch for these changes -* If you have additional dependencies for ``Minio``, ``Minio`` manages its dependencies using [govendor](https://github.com/kardianos/govendor) - - Run `go get foo/bar` - - Edit your code to import foo/bar - - Run `make pkg-add PKG=foo/bar` from top-level directory +``` +$ git checkout -b my-new-feature +``` -* If you have dependencies for ``Minio`` which needs to be removed - - Edit your code to not import foo/bar - - Run `make pkg-remove PKG=foo/bar` from top-level directory +### Test Minio server changes +After your code changes, make sure -* 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 `make verifiers` - - 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. +- To add test cases for the new code. If you have questions about how to do it, please ask on our [Slack](slack.minio.io) channel. +- To run `make verifiers` +- To squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request. +- To run `go test -race ./...` and `go build` completes. -* Read [Effective Go](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project - - `Minio` project is fully conformant with Golang style - - if you happen to observe offending code, please feel free to send a pull request +### Commit changes +After verification, commit your changes. This is a [great post](https://chris.beams.io/posts/git-commit/) on how to write useful commit messages + +``` +$ git commit -am 'Add some feature' +``` + +### Push to the branch +Push your locally committed changes to the remote origin (your fork) +``` +$ git push origin my-new-feature +``` + +### Create a Pull Request +Pull requests can be created via GitHub. Refer to [this document](https://help.github.com/articles/creating-a-pull-request/) for detailed steps on how to create a pull request. After a Pull Request gets peer reviewed and approved, it will be merged. + +## FAQs +### How does ``Minio`` manages dependencies? +``Minio`` manages its dependencies using [govendor](https://github.com/kardianos/govendor). To add a dependency +- Run `go get foo/bar` +- Edit your code to import foo/bar +- Run `make pkg-add PKG=foo/bar` from top-level directory + +To remove a dependency +- Edit your code to not import foo/bar +- Run `make pkg-remove PKG=foo/bar` from top-level directory + +### What are the coding guidelines for Minio? +``Minio`` is fully conformant with Golang style. Refer: [Effective Go](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project. If you observe offending code, please feel free to send a pull request or ping us on [Slack](slack.minio.io).