|
@@ -1,27 +1,38 @@
|
1
|
|
-Want to contribute? Great! First, read this page (including the small print at the end).
|
2
|
|
-
|
3
|
|
-### Before you contribute
|
4
|
|
-
|
5
|
|
-Before we can use your code, you must sign the
|
6
|
|
-[Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
|
7
|
|
-(CLA), which you can do online. The CLA is necessary mainly because you own the
|
8
|
|
-copyright to your changes, even after your contribution becomes part of our
|
9
|
|
-codebase, so we need your permission to use and distribute your code. We also
|
10
|
|
-need to be sure of various other things—for instance that you'll tell us if you
|
11
|
|
-know that your code infringes on other people's patents. You don't have to sign
|
12
|
|
-the CLA until after you've submitted your code for review and a member has
|
13
|
|
-approved it, but you must do it before we can put your code into our codebase.
|
14
|
|
-Before you start working on a larger contribution, you should get in touch with
|
15
|
|
-us first through the issue tracker with your idea so that we can help out and
|
16
|
|
-possibly guide you. Coordinating up front makes it much easier to avoid
|
17
|
|
-frustration later on.
|
18
|
|
-
|
19
|
|
-### Code reviews
|
20
|
|
-
|
21
|
|
-All submissions, including submissions by project members, require review.
|
|
1
|
+Want to contribute? Great: read the page (including the small print at the end).
|
|
2
|
+
|
|
3
|
+# Before you contribute
|
|
4
|
+
|
|
5
|
+As an individual, sign the [Google Individual Contributor License
|
|
6
|
+Agreement](https://cla.developers.google.com/about/google-individual) (CLA)
|
|
7
|
+online. This is required for any of your code to be accepted.
|
|
8
|
+
|
|
9
|
+Before you start working on a larger contribution, get in touch with us first
|
|
10
|
+through the issue tracker with your idea so that we can help out and possibly
|
|
11
|
+guide you. Coordinating up front makes it much easier to avoid frustration later
|
|
12
|
+on.
|
|
13
|
+
|
|
14
|
+# Code reviews
|
|
15
|
+
|
|
16
|
+All submissions, including submissions by project members, require review.
|
22
|
17
|
We use Github pull requests for this purpose.
|
23
|
18
|
|
24
|
|
-### The small print
|
|
19
|
+The pprof source code is in Go with a bit of JavaScript, CSS and HTML. If you
|
|
20
|
+are new to Go, read [Effective Go](https://golang.org/doc/effective_go.html) and
|
|
21
|
+the [summary on typical comments during Go code
|
|
22
|
+reviews](https://github.com/golang/go/wiki/CodeReviewComments).
|
|
23
|
+
|
|
24
|
+Cover all new functionality with tests. Enable Travis on your forked repo,
|
|
25
|
+enable builds of branches and make sure Travis is happily green for the branch
|
|
26
|
+with your changes.
|
|
27
|
+
|
|
28
|
+The code coverage is measured for each pull request. The code coverage is
|
|
29
|
+expected to go up with every change.
|
|
30
|
+
|
|
31
|
+Pull requests not meeting the above guidelines will get less attention than good
|
|
32
|
+ones, so make sure your submissions are high quality.
|
|
33
|
+
|
|
34
|
+# The small print
|
25
|
35
|
|
26
|
|
-Contributions made by corporations are covered by a different agreement than the one above,
|
27
|
|
-the [Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).
|
|
36
|
+Contributions made by corporations are covered by a different agreement than the
|
|
37
|
+one above, the [Software Grant and Corporate Contributor License
|
|
38
|
+Agreement](https://cla.developers.google.com/about/google-corporate).
|