From 661229d7f7827e049c47689e05e9c6e89bf9522e Mon Sep 17 00:00:00 2001 From: Harshavardhana Date: Wed, 2 Dec 2015 10:50:54 -0800 Subject: [PATCH] doc: Add MAINTAINERS.md --- MAINTAINERS.md | 37 +++++++++++++++++++++++++++++++++++++ Makefile | 3 +++ release.sh | 0 3 files changed, 40 insertions(+) create mode 100644 MAINTAINERS.md mode change 100644 => 100755 release.sh diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 000000000..bcc95cb38 --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,37 @@ +# For maintainers only + +### Setup your minio Github Repository + +Fork [minio upstream](https://github.com/minio/minio/fork) source repository to your own personal repository. +```bash +$ mkdir -p $GOPATH/src/github.com/minio +$ cd $GOPATH/src/github.com/minio +$ git clone https://github.com/$USER_ID/minio +$ +``` + +``minio`` uses [govendor](https://github.com/kardianos/govendor) for its dependency management. + +### To manage dependencies + +#### Add new dependencies + + - Run `go get foo/bar` + - Edit your code to import foo/bar + - Run `govendor add foo/bar` from top-level folder + +#### Remove dependencies + + - Run `govendor remove foo/bar` + +#### Update dependencies + + - Run `govendor remove +vendor` + - Run to update the dependent package `go get -u foo/bar` + - Run `govendor add +external` + +### Making new releases + +`minio` doesn't follow semantic versioning style, `minio` instead uses the release date and time as the release versions. + +`make release` will install new released binary into your `GOPATH` diff --git a/Makefile b/Makefile index dacea5c7d..3b3382fcc 100644 --- a/Makefile +++ b/Makefile @@ -79,6 +79,9 @@ dockerimage: install @rmdir export @rm minio.dockerimage +release: + @./release.sh + clean: @echo "Cleaning up all the generated files:" @rm -fv cover.out diff --git a/release.sh b/release.sh old mode 100644 new mode 100755