3
3
We'd love to accept your patches and contributions to this project. There are
4
4
just a few small guidelines you need to follow.
5
5
6
+ ## Setup
7
+
8
+ If you haven't written Go code on your machine before, first follow the official
9
+ Golang instructions for setting up your environment: https://golang.org/doc/code.html
10
+
11
+ Once you have your environment set up, create a fork of the container-diff repository
12
+ with your personal GitHub account. Then, clone the fork into your ` $GOPATH ` :
13
+
14
+ ``` bash
15
+ git clone
[email protected] :
< your_account
> /container-diff.git
16
+ $GOPATH /src/github.com/GoogleCloudPlatform &&
17
+ cd $GOPATH /src/github.com/GoogleCloudPlatform/container-diff &&
18
+ git remote add upstream
[email protected] :GoogleCloudPlatform/container-diff.git
19
+ ```
20
+
21
+ The last command here sets the official repository as an upstream repository for
22
+ your fork, so you can keep your fork in sync with ` MASTER ` :
23
+
24
+ ``` bash
25
+ (container-diff) git pull upstream master && git push origin master
26
+ ```
27
+
28
+ ## Building
29
+
30
+ From the project root, run ` make clean && make ` . Under the hood, this essentially
31
+ just runs a ` go build ` on the project root to create an executable in ` /out ` .
32
+
33
+ ## Code reviews
34
+
35
+ All submissions, including submissions by project members, require review. We
36
+ use GitHub pull requests for this purpose. Consult
37
+ [ GitHub Help] ( https://help.github.com/articles/about-pull-requests/ ) for more
38
+ information on using pull requests.
39
+
6
40
## Contributor License Agreement
7
41
8
42
Contributions to this project must be accompanied by a Contributor License
@@ -15,13 +49,6 @@ You generally only need to submit a CLA once, so if you've already submitted one
15
49
(even if it was for a different project), you probably don't need to do it
16
50
again.
17
51
18
- ## Code reviews
19
-
20
- All submissions, including submissions by project members, require review. We
21
- use GitHub pull requests for this purpose. Consult
22
- [ GitHub Help] ( https://help.github.com/articles/about-pull-requests/ ) for more
23
- information on using pull requests.
24
-
25
52
## Tests
26
53
27
54
Before sending a PR, please make sure the included tests pass.
0 commit comments