Merge pull request #149 from harshavardhana/pr_out_update_contributors_document

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
+    - Fork it
-  - Create your feature branch (git checkout -b my-new-feature)
+    - Create your feature branch (git checkout -b my-new-feature)
-  - Commit your changes (git commit -am 'Add some feature')
+    - Commit your changes (git commit -am 'Add some feature')
-  - Push to the branch (git push origin my-new-feature)
+    - Push to the branch (git push origin my-new-feature)
-  - Create new Pull Request
+    - 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`
+    - Run `go get foo/bar`
-  - Edit your code to import foo/bar
+    - Edit your code to import foo/bar
-  - Run `make save` from top-level directory (or `godep restore && godep save ./...`).
+    - 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.
+    - 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`
+    - Run `go fmt`
-  - Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request.
+    - 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.
+    - 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
+    - `Minio` project is strictly conformant with Golang style
-  - if you happen to observe offending code, please feel free to send a pull request
+    - if you happen to observe offending code, please feel free to send a pull request

docs/contributing.md

@@ -0,0 +1 @@
+../CONTRIBUTING.md

mkdocs.yml

@@ -1,7 +1,8 @@
 site_name: Minio Documentation
 pages:
 - ['index.md', Index]
-- ['api/minio.md', 'API', 'Minio'] 
+- ['api/minio.md', 'API', 'Minio']
-- ['api/manage.md', 'API', 'Management'] 
+- ['api/manage.md', 'API', 'Management']
 - ['architecture.md', 'Architecture', 'Overview']
+- ['contributing.md', 'Contributing', 'Overview']
 theme: readthedocs