add some notes on how to hack on go-ipfs
License: MIT Signed-off-by: Jeromy <jeromyj@gmail.com>
Jeromy committed
Oct 3, 2015 at 10:33 UTC
9f4c5e9d0a9ea4b0d0daef254df691132f03f0c8
1 file changed
+13
-2
contribute.md
+13
-2
@@ -4,7 +4,7 @@ go-ipfs is MIT licensed open source software. We welcome contributions big and
4
small! Take a look at the [community contributing notes](https://github.com/ipfs/community/blob/master/contributing.md). Please make sure to check the [issues](https://github.com/ipfs/go-ipfs/issues). Search the closed ones
5
before reporting things, and help us with the open ones.
6
7
-Guidelines:
7
+General Guidelines:
8
9
- see the [dev pseudo-roadmap](dev.md)
10
- please adhere to the protocol described in [the main ipfs repo](https://github.com/ipfs/ipfs), [paper](http://static.benet.ai/t/ipfs.pdf), and [specs](https://github.com/ipfs/specs) (WIP).
@@ -14,4 +14,15 @@ Guidelines:
14
- run `go fmt` before pushing any code
15
- run `golint` and `go vet` too -- some things (like protobuf files) are expected to fail.
16
- 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)
17
-- have fun!
\ No newline at end of file
17
+- have fun!
18
+
19
+A short intro to the Go development workflow:
20
+
21
+- Ensure you have [Go installed on your system](https://golang.org/doc/install).
22
+- Make sure that you have the environment variable `GOPATH` set somewhere, e.g. `$HOME/gopkg`
23
+- Clone ipfs into the path `$GOPATH/src/github.com/ipfs/go-ipfs`
24
+ - NOTE: This is true even if you have forked go-ipfs, dependencies in go are path based and must be in the right locations.
25
+- You are now free to make changes to the codebase as you please.
26
+- You can build the binary by running `go build ./cmd/ipfs` from the go-ipfs directory.
27
+ - NOTE: when making changes remember to restart your daemon to ensure its running your new code.
28
+