Merge pull request #989 from harshavardhana/maintainers

doc: Add MAINTAINERS.md
This commit is contained in:
Harshavardhana 2015-12-02 10:55:30 -08:00
commit df94b4d3ca
3 changed files with 40 additions and 0 deletions

37
MAINTAINERS.md Normal file
View file

@ -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`

View file

@ -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

0
release.sh Normal file → Executable file
View file