Pared down contribute to link to new go guidelines
License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
Oct 19, 2015 at 10:35 UTC
d90f2fd8fa98106dd195c5551f30a0bd58e74faa
1 file changed
+10
-19
contribute.md
+10
-19
@@ -4,25 +4,16 @@ 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
-General Guidelines:
7
+Go 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).
11
-- please make branches + pull-request, even if working on the main repository
12
-- ask questions or talk about things in [Issues](https://github.com/ipfs/go-ipfs/issues) or #ipfs on freenode.
13
-- ensure you are able to contribute (no legal issues please-- we'll probably setup a CLA)
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!
9
+- Please look and conform to our [Go Contribution Guidelines](https://github.com/ipfs/community/go-contribution-guidelines.md).
10
19
-A short intro to the Go development workflow:
11
+General Guidelines:
12
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
-
13
+- See the [dev pseudo-roadmap](dev.md).
14
+- 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).
15
+- Please make branches and pull-request, even if working on the main repository.
16
+- Ask questions or talk about things in [Issues](https://github.com/ipfs/go-ipfs/issues) or #ipfs on freenode.
17
+- Ensure you are able to contribute (no legal issues please-- we'll probably setup a CLA).
18
+- 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).
19
+- Have fun!