simple contrib guidelines #17
Juan Batiz-Benet committed
Jul 30, 2014 at 02:09 UTC
0ae4d8060d6b308d0ff43241e77af81d9d880ef9
1 file changed
+20
README.md
+20
@@ -41,3 +41,23 @@ Advanced Commands:
41
42
Use "ipfs help <command>" for more information about a command.
43
```
44
+
45
+## Contributing
46
+
47
+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.
48
+
49
+Guidelines:
50
+
51
+- 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).
52
+- please make branches + pull-request, even if working on the main repository
53
+- ask questions or talk about things in [Issues](https://github.com/jbenet/go-ipfs/issues) or #ipfs on freenode.
54
+- ensure you are able to contribute (no legal issues please-- we'll probably setup a CLA)
55
+- run `go fmt` before pushing any code
56
+- run `golint` and `go vet` too -- some things (like protobuf files) are expected to fail.
57
+- 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)
58
+- have fun!
59
+
60
+
61
+## License
62
+
63
+MIT