| Primiano Tucci | 53ba8cf | 2019-12-05 00:47:52 +0000 | [diff] [blame] | 1 | # Contributing to Perfetto |
| 2 | This project uses [Android AOSP Gerrit][perfetto-gerrit] for code reviews, |
| Primiano Tucci | b808373 | 2018-04-09 15:38:37 +0100 | [diff] [blame] | 3 | uses the [Google C++ style][google-cpp-style] and targets `-std=c++11`. |
| 4 | |
| Primiano Tucci | 53ba8cf | 2019-12-05 00:47:52 +0000 | [diff] [blame] | 5 | Development happens in this repo: |
| 6 | https://android.googlesource.com/platform/external/perfetto/ |
| 7 | |
| 8 | ## Contributor License Agreement |
| 9 | |
| 10 | Contributions to this project must be accompanied by a Contributor License |
| 11 | Agreement. You (or your employer) retain the copyright to your contribution; |
| 12 | this simply gives us permission to use and redistribute your contributions as |
| 13 | part of the project. Head over to <https://cla.developers.google.com/> to see |
| 14 | your current agreements on file or to sign a new one. |
| 15 | |
| 16 | You generally only need to submit a CLA once, so if you've already submitted one |
| 17 | (even if it was for a different project), you probably don't need to do it |
| 18 | again. |
| 19 | |
| 20 | ## Code Reviews |
| 21 | |
| 22 | All submissions, including submissions by project members, require review. |
| 23 | We use [Android AOSP Gerrit][perfetto-gerrit] for this purpose. |
| 24 | |
| Primiano Tucci | b808373 | 2018-04-09 15:38:37 +0100 | [diff] [blame] | 25 | `git cl upload` from [Chromium depot tools][depot-tools] is the preferred |
| 26 | workflow to upload patches, as it supports presubmits and code formatting via |
| 27 | `git cl format`. |
| 28 | |
| Primiano Tucci | 53ba8cf | 2019-12-05 00:47:52 +0000 | [diff] [blame] | 29 | ## Continuous integration |
| Primiano Tucci | b808373 | 2018-04-09 15:38:37 +0100 | [diff] [blame] | 30 | |
| 31 | Continuous build and test coverage is available at |
| Primiano Tucci | 48fb503 | 2019-08-29 09:24:21 +0200 | [diff] [blame] | 32 | [ci.perfetto.dev](https://ci.perfetto.dev). |
| Primiano Tucci | b808373 | 2018-04-09 15:38:37 +0100 | [diff] [blame] | 33 | |
| Primiano Tucci | 48fb503 | 2019-08-29 09:24:21 +0200 | [diff] [blame] | 34 | **Trybots**: |
| Primiano Tucci | 53ba8cf | 2019-12-05 00:47:52 +0000 | [diff] [blame] | 35 | CLs uploaded to Gerrit are automatically submitted to the CI and |
| Primiano Tucci | 48fb503 | 2019-08-29 09:24:21 +0200 | [diff] [blame] | 36 | and available on the CI page. |
| 37 | If the label `Presubmit-Ready: +1` is set, the CI will also publish a comment |
| 38 | like [this][ci-example] on the CL. |
| Primiano Tucci | b808373 | 2018-04-09 15:38:37 +0100 | [diff] [blame] | 39 | |
| Primiano Tucci | 53ba8cf | 2019-12-05 00:47:52 +0000 | [diff] [blame] | 40 | ## Community |
| Primiano Tucci | 0523f42 | 2019-10-11 15:36:52 +0100 | [diff] [blame] | 41 | |
| 42 | You can reach us on our [Discord channel](https://discord.gg/35ShE3A). |
| 43 | If you prefer using IRC we have an experimental Discord <> IRC bridge |
| 44 | synced with `#perfetto-dev` on [Freenode](https://webchat.freenode.net/). |
| 45 | |
| Primiano Tucci | 53ba8cf | 2019-12-05 00:47:52 +0000 | [diff] [blame] | 46 | This project follows |
| 47 | [Google's Open Source Community Guidelines](https://opensource.google/conduct/). |
| 48 | |
| Primiano Tucci | b808373 | 2018-04-09 15:38:37 +0100 | [diff] [blame] | 49 | [perfetto-gerrit]: https://android-review.googlesource.com/q/project:platform%252Fexternal%252Fperfetto+status:open |
| 50 | [google-cpp-style]: https://google.github.io/styleguide/cppguide.html |
| 51 | [depot-tools]: https://dev.chromium.org/developers/how-tos/depottools |
| Primiano Tucci | 48fb503 | 2019-08-29 09:24:21 +0200 | [diff] [blame] | 52 | [ci-example]: https://android-review.googlesource.com/c/platform/external/perfetto/+/1108253/3#message-09fd27fb92ca8357abade3ec725919ac3445f3af |
