From 0ac611e452a883708f7bf4afa6bb97a4c726ada9 Mon Sep 17 00:00:00 2001 From: Harshavardhana Date: Mon, 9 Feb 2015 13:34:19 -0800 Subject: [PATCH] Update contributors document --- CONTRIBUTING.md | 29 +++++++++++++++-------------- docs/contributing.md | 1 + mkdocs.yml | 5 +++-- 3 files changed, 19 insertions(+), 16 deletions(-) create mode 120000 docs/contributing.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1803aa33e..cab38735b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,20 +22,21 @@ 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 + - 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 + * If you have additional dependencies for ``Minio``, ``Minio`` manages its depedencies using [godep](https://github.com/tools/godep) - - Run `go get foo/bar` - - Edit your code to import foo/bar - - Run `make save` from top-level directory (or `godep restore && godep save ./...`). + - Run `go get foo/bar` + - Edit your code to import foo/bar + - Run `make save` from top-level directory (or `godep restore && godep save ./...`). * 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 fmt` - - 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. + - Have test cases for the new code. If you have questions about how to do it, please ask in your pull request. + - Run `go fmt` + - 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](https://github.com/golang/go/wiki/CodeReviewComments) article from Golang project - - `Minio` project is strictly conformant with Golang style - - if you happen to observe offending code, please feel free to send a pull request + - `Minio` project is strictly conformant with Golang style + - if you happen to observe offending code, please feel free to send a pull request diff --git a/docs/contributing.md b/docs/contributing.md new file mode 120000 index 000000000..44fcc6343 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1 @@ +../CONTRIBUTING.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 974be65d1..2efa2fd86 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,7 +1,8 @@ site_name: Minio Documentation pages: - ['index.md', Index] -- ['api/minio.md', 'API', 'Minio'] -- ['api/manage.md', 'API', 'Management'] +- ['api/minio.md', 'API', 'Minio'] +- ['api/manage.md', 'API', 'Management'] - ['architecture.md', 'Architecture', 'Overview'] +- ['contributing.md', 'Contributing', 'Overview'] theme: readthedocs