aboutsummaryrefslogtreecommitdiff
path: root/src/cmd/vendor/github.com/google/pprof/CONTRIBUTING.md
diff options
context:
space:
mode:
authorDaniel Martí <mvdan@mvdan.cc>2018-02-12 16:34:48 +0000
committerDaniel Martí <mvdan@mvdan.cc>2018-02-15 16:25:43 +0000
commite7cbbbe9bb878b6ca4ce04fde645df1c8f1845bd (patch)
treef84255198234eb4870c48228cdb4828de1f4f8c5 /src/cmd/vendor/github.com/google/pprof/CONTRIBUTING.md
parentafb9fc1de922a4ead9d2d787613255a7ba3490f7 (diff)
downloadgo-e7cbbbe9bb878b6ca4ce04fde645df1c8f1845bd.tar.xz
cmd/vendor/github.com/google/pprof: refresh from upstream
Updating to commit 0e0e5b7254e076a62326ab7305ba49e8515f0c91 from github.com/google/pprof Recent modifications to the vendored pprof, such as skipping TestWebInterface to avoid starting a web browser, have all been fixed upstream. Change-Id: I72e11108c438e1573bf2f9216e76d157378e8d45 Reviewed-on: https://go-review.googlesource.com/93375 Run-TryBot: Daniel Martí <mvdan@mvdan.cc> TryBot-Result: Gobot Gobot <gobot@golang.org> Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Diffstat (limited to 'src/cmd/vendor/github.com/google/pprof/CONTRIBUTING.md')
-rw-r--r--src/cmd/vendor/github.com/google/pprof/CONTRIBUTING.md92
1 files changed, 71 insertions, 21 deletions
diff --git a/src/cmd/vendor/github.com/google/pprof/CONTRIBUTING.md b/src/cmd/vendor/github.com/google/pprof/CONTRIBUTING.md
index 5976686d73..e793970674 100644
--- a/src/cmd/vendor/github.com/google/pprof/CONTRIBUTING.md
+++ b/src/cmd/vendor/github.com/google/pprof/CONTRIBUTING.md
@@ -1,27 +1,77 @@
-Want to contribute? Great! First, read this page (including the small print at the end).
+Want to contribute? Great: read the page (including the small print at the end).
-### Before you contribute
+# Before you contribute
-Before we can use your code, you must sign the
-[Google Individual Contributor License Agreement](https://cla.developers.google.com/about/google-individual)
-(CLA), which you can do online. The CLA is necessary mainly because you own the
-copyright to your changes, even after your contribution becomes part of our
-codebase, so we need your permission to use and distribute your code. We also
-need to be sure of various other things—for instance that you'll tell us if you
-know that your code infringes on other people's patents. You don't have to sign
-the CLA until after you've submitted your code for review and a member has
-approved it, but you must do it before we can put your code into our codebase.
-Before you start working on a larger contribution, you should get in touch with
-us first through the issue tracker with your idea so that we can help out and
-possibly guide you. Coordinating up front makes it much easier to avoid
-frustration later on.
+As an individual, sign the [Google Individual Contributor License
+Agreement](https://cla.developers.google.com/about/google-individual) (CLA)
+online. This is required for any of your code to be accepted.
-### Code reviews
+Before you start working on a larger contribution, get in touch with us first
+through the issue tracker with your idea so that we can help out and possibly
+guide you. Coordinating up front makes it much easier to avoid frustration later
+on.
-All submissions, including submissions by project members, require review.
-We use Github pull requests for this purpose.
+# Development
-### The small print
+Make sure `GOPATH` is set in your current shell. The common way is to have
+something like `export GOPATH=$HOME/gocode` in your `.bashrc` file so that it's
+automatically set in all console sessions.
-Contributions made by corporations are covered by a different agreement than the one above,
-the [Software Grant and Corporate Contributor License Agreement](https://cla.developers.google.com/about/google-corporate).
+To get the source code, run
+
+```
+go get github.com/google/pprof
+```
+
+To run the tests, do
+
+```
+cd $GOPATH/src/github.com/google/pprof
+go test -v ./...
+```
+
+When you wish to work with your own fork of the source (which is required to be
+able to create a pull request), you'll want to get your fork repo as another Git
+remote in the same `github.com/google/pprof` directory. Otherwise, if you'll `go
+get` your fork directly, you'll be getting errors like `use of internal package
+not allowed` when running tests. To set up the remote do something like
+
+```
+cd $GOPATH/src/github.com/google/pprof
+git remote add aalexand git@github.com:aalexand/pprof.git
+git fetch aalexand
+git checkout -b my-new-feature
+# hack hack hack
+go test -v ./...
+git commit -a -m "Add new feature."
+git push aalexand
+```
+
+where `aalexand` is your GitHub user ID. Then proceed to the GitHub UI to send a
+code review.
+
+# Code reviews
+
+All submissions, including submissions by project members, require review.
+We use GitHub pull requests for this purpose.
+
+The pprof source code is in Go with a bit of JavaScript, CSS and HTML. If you
+are new to Go, read [Effective Go](https://golang.org/doc/effective_go.html) and
+the [summary on typical comments during Go code
+reviews](https://github.com/golang/go/wiki/CodeReviewComments).
+
+Cover all new functionality with tests. Enable Travis on your forked repo,
+enable builds of branches and make sure Travis is happily green for the branch
+with your changes.
+
+The code coverage is measured for each pull request. The code coverage is
+expected to go up with every change.
+
+Pull requests not meeting the above guidelines will get less attention than good
+ones, so make sure your submissions are high quality.
+
+# The small print
+
+Contributions made by corporations are covered by a different agreement than the
+one above, the [Software Grant and Corporate Contributor License
+Agreement](https://cla.developers.google.com/about/google-corporate).