CONTRIBUTING.md 1.6KB
Want to contribute? Great: read the page (including the small print at the end).
Before you contribute
As an individual, sign the Google Individual Contributor License Agreement (CLA) online. This is required for any of your code to be accepted.
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.
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 and the summary on typical comments during Go code reviews.
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.