RepoMirrors
/
go-ceph
mirror of https://github.com/ceph/go-ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #25 from theanalyst/doc/contribute 

doc: add basic instructions for contributing

Signed-off-by:  Noah Watkins <noahwatkins@gmail.com>
This commit is contained in:
Noah Watkins 2015-07-17 11:28:02 -06:00
parent 8f882afdc3 2d8d57f246
commit 0448b62d47
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -91,3 +91,20 @@ delete a pool with the given name. The following will delete the pool named
```go
conn.DeletePool("new_pool")
```
## Contributing
Contributions are welcome & greatly appreciated, every little bit helps. Make code changes via Github pull requests:
- Fork the repo and create a topic branch for every feature/fix. Avoid
making changes directly on master branch.
- All incoming features should be accompanied with tests.
- Make sure that you run `go fmt` before submitting a change
set. Alternatively the Makefile has a flag for this, so you can call
`make fmt` as well.
- The integration tests can be run in a docker container, for this run:
```
make test-docker
```