From 0ae4d8060d6b308d0ff43241e77af81d9d880ef9 Mon Sep 17 00:00:00 2001 From: Juan Batiz-Benet <juan@benet.ai> Date: Wed, 30 Jul 2014 02:09:43 -0700 Subject: [PATCH] simple contrib guidelines #17 --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index ed12471f..414fb402 100644 --- a/README.md +++ b/README.md @@ -41,3 +41,23 @@ Advanced Commands: Use "ipfs help <command>" for more information about a command. ``` + +## Contributing + +go-ipfs is MIT licensed open source software. We welcome contributions big and small! Please make sure to check the [issues](https://github.com/jbenet/go-ipfs/issues). Search the closed ones before reporting things, and help us with the open ones. + +Guidelines: + +- please adhere to the protocol described in [the main ipfs repo](https://github.com/jbenet/ipfs) and [paper](http://static.benet.ai/t/ipfs.pdf). +- please make branches + pull-request, even if working on the main repository +- ask questions or talk about things in [Issues](https://github.com/jbenet/go-ipfs/issues) or #ipfs on freenode. +- ensure you are able to contribute (no legal issues please-- we'll probably setup a CLA) +- run `go fmt` before pushing any code +- run `golint` and `go vet` too -- some things (like protobuf files) are expected to fail. +- if you'd like to work on ipfs part-time (20+ hrs/wk) or full-time (40+ hrs/wk), contact [@jbenet](https://github.com/jbenet) +- have fun! + + +## License + +MIT -- GitLab