blob: 610d8dfc32d617517cf7fe905c805598e5b52c9a [file] [log] [blame] [view]
Daniel Cheng86135f32019-02-27 07:10:381# Contributing to Chromium
2
3This page assumes a working Chromium [checkout and build][checkout-and-build].
4Note that a full Chromium checkout includes external repositories with their
5own workflows for contributing, such as [v8][v8-dev-guide] and
6[Skia][skia-dev-guide]. Similarly, ChromiumOS, which includes Chromium as a
7subrepository, has its own [development workflow][cros-dev-guide].
8
9[TOC]
10
11## Related resources
12
13- [Life of a Chromium Developer][life-of-a-chromium-developer], which is mostly
14 up-to-date.
Toby Huang5105f812019-08-08 23:47:5715- [Tutorial][noms-tutorial] by committer emeritus [email protected].
16- [Commit Checklist][commit-checklist], a useful checklist to go through before
17 submitting each CL on Gerrit.
Daniel Cheng86135f32019-02-27 07:10:3818
19## Communicate
20
21When writing a new feature or fixing an existing bug, get a second opinion
22before going too far. If it's a new feature idea, propose it to the appropriate
23[discussion group][discussion-groups]. If it's in the existing code base, talk
24to some of the folks in the "OWNERS" file (see [code review
25policies][code-reviews] for more) for the code being changed.
26
27- If a change needs further context outside the CL, it should be tracked in the
28 [bug system][crbug]. Bugs are the right place for long histories, discussion
29 and debate, attaching screenshots, and linking to other associated bugs. Bugs
30 are unnecessary for changes isolated enough to need none of these.
31- If there isn't a bug and there should be one, please [file a new
32 bug][crbug-new].
33- Just because there is a bug in the bug system doesn't necessarily mean that a
34 patch will be accepted.
35
John Abd-El-Malek27e1cf02019-12-18 17:35:1836## Design Documents
37Any nontrivial technical effort that will significantly impact Chromium should
38have a design doc ([template][design-doc-template]). Specifically, we require
39design docs in the following cases:
40- When writing code that will have a large impact on Chromium as a whole, e.g.
41 when you are changing code in Chromium's critical path (page loading,
42 rendering).
43- When beginning a large technical undertaking that should be documented for
44 historical reasons (>1 person-month of work can be used as a general guideline).
45
46Send public design docs to
47[[email protected]][chromium-design-docs]. Google internal Chrome
48design docs should follow the process at
49[go/chrome-dd-review-process][chrome-dd-review-process].
50
Daniel Cheng86135f32019-02-27 07:10:3851## Legal stuff
52
Dirk Prankeb12d67032022-01-13 17:19:2153All contributors must have valid Gerrit/Google accounts (which means you must
54be [old enough to manage your own
55account](https://support.google.com/accounts/answer/1350409)) and complete the
56contributor license agreement.
57
58For individual contributors, please complete the [Individual Contributor License
Daniel Cheng86135f32019-02-27 07:10:3859Agreement][individual-cla] online. Corporate contributors must fill out the
60[Corporate Contributor License Agreement][corporate-cla] and send it to us as
61described on that page.
62
63### First-time contributors
64
65Add your (or your organization's) name and contact info to the AUTHORS file for
66[Chromium][cr-authors] or [Chromium OS][cros-authors]. Please include this as
67part of your first patch and not as a separate standalone patch.
68
69### External contributor checklist for reviewers
70
71Before LGTMing a change from a non-chromium.org address, ensure that the
72contribution can be accepted:
73
74- Definition: The "author" is the email address that owns the code review
75 request on <https://chromium-review.googlesource.com>
76- Ensure the author is already listed in [AUTHORS][cr-authors]. In some cases, the
77 author's company might have a wildcard rule (e.g. \*@google.com).
78- If the author or their company is not listed, the CL should include a new
79 AUTHORS entry.
80 - Ensure the new entry is reviewed by a reviewer who works for Google.
Vincent Scheib04582d842020-04-24 18:41:3681 - Contributor License Agreement can be verified by Googlers at http://go/cla.
Daniel Cheng86135f32019-02-27 07:10:3882 - If there is a corporate CLA for the author's company, it must list the
83 person explicitly (or the list of authorized contributors must say
84 something like "All employees"). If the author is not on their company's
85 roster, do not accept the change.
86
87## Initial git setup
88
Caleb Raittobbf16d52023-02-07 18:34:01891. Visit <https://chromium.googlesource.com/new-password> and follow the
Daniel Cheng86135f32019-02-27 07:10:3890 on-screen instructions to get credentials for uploading changes.
912. Tell git about your name, email and some other settings.
92 ```
93 git config --global user.name "My Name"
94 git config --global user.email "[email protected]"
95 git config --global core.autocrlf false
96 git config --global core.filemode false
97 git config --local gerrit.host true
98 # Uncomment this if you want your pull commands to always rebase.
99 # git config --global branch.autosetuprebase always
100 # Uncomment if you want new branches to track the current branch.
101 # git config --global branch.autosetupmerge always
102 ```
Francois Marier197916f2020-01-16 02:23:021033. Visit <https://chromium-review.googlesource.com/settings/> to ensure that
104 your preferred email is set to the same one you use in your git
105 configuration.
Daniel Cheng86135f32019-02-27 07:10:38106
107## Creating a change
108
109First, create a new branch for your change in git. Here, we create a branch
Emily Stark84d57192021-05-14 18:58:25110called `mychange` (use whatever name you want here), with `origin/main` as
Daniel Cheng86135f32019-02-27 07:10:38111the upstream branch.
112
113```
Emily Stark84d57192021-05-14 18:58:25114git checkout -b mychange -t origin/main
Daniel Cheng86135f32019-02-27 07:10:38115```
116
117Write and test your change.
118
119- Conform to the [style guide][cr-styleguide].
120- Include tests.
121- Patches should be a reasonable size to review. Review time often increases
Joshua Berenhaus98d2fbc2020-01-07 18:50:42122 exponentially with patch size.
Daniel Cheng86135f32019-02-27 07:10:38123
124Commit your change locally in git:
125
126```
127git commit -a
128```
129
130If you are not familiar with `git`, GitHub's [resources to learn
131git][github-tutorial] is useful for the basics. However, keep in mind that the
132Chromium workflow is not the same as the GitHub pull request workflow.
133
134## Uploading a change for review
135
Peter Kasting60d30282024-08-23 06:22:58136Note: If your change is to a dependent project, see the documentation on
137[changing dependencies](dependencies.md#changing-dependencies). Otherwise, go
138through the [commit checklist][commit-checklist] for Chromium before uploading a
139change for review.
Toby Huang5105f812019-08-08 23:47:57140
Daniel Cheng86135f32019-02-27 07:10:38141Chromium uses a Gerrit instance hosted at
142<https://chromium-review.googlesource.com> for code reviews. In order to upload
143your local change to Gerrit, use `git-cl` from
144[depot\_tools][depot-tools-setup] to create a new Gerrit change, based on the
145diff between the current branch and its upstream branch:
146
147```
148git cl upload
149```
150
151This will open a text editor to create a description for the new change. This
152description will be used as the commit message when the change is landed in the
153Chromium tree. Descriptions should be formatted as follows:
154
155```
156Summary of change (one line)
157
158Longer description of change addressing as appropriate: why the change
159is made, context if it is part of many changes, description of previous
160behavior and newly introduced differences, etc.
161
162Long lines should be wrapped to 72 columns for easier log message
163viewing in terminals.
164
165Bug: 123456
166```
167
168A short subject and a blank line after the subject are crucial: `git` uses this
169as a heuristic for tools like `git log --oneline`. Use the bug number from the
Kalvin Lee23598832020-07-22 07:36:28170[issue tracker][crbug] (see more on [CL footer syntax](#cl-footer-reference)).
171Also see [How to Write a Git Commit Message][good-git-commit-message], which
172has more in-depth tips for writing a good commit description.
Daniel Cheng86135f32019-02-27 07:10:38173
174### Chromium-specific description tips
175
176- Links to previous CLs should be formatted as `https://crrev.com/c/NUMBER`,
Kalvin Lee313a7f22022-08-22 08:20:45177 which is slightly shorter than <https://chromium-review.googlesource.com>.
Daniel Cheng86135f32019-02-27 07:10:38178
179- If there are instructions for testers to verify the change is correct,
180 include them with the `Test:` tag:
181
182 ```
183 Test: Load example.com/page.html and click the foo-button; see
184 crbug.com/123456 for more details.
185 ```
186
187After saving the change description, `git-cl` runs some presubmit scripts to
188check for common errors. If everything passes, `git-cl` will print something
189like this:
190
191```
192remote: SUCCESS
193remote:
194remote: New Changes:
195remote: https://chromium-review.googlesource.com/c/chromium/src/+/1485699 Use base::TimeDelta::FromTimeSpec helper in more places. [WIP]
196```
197
198Additional flags can be used to specify reviewers, bugs fixed by the change, et
199cetera:
200
201```
202git cl upload -r [email protected],[email protected] -b 123456
203```
204
205See `git cl help upload` for a full list of flags.
206
Andrea Orru771255242023-02-27 02:41:28207### Uploading dependent changes
208
209If you wish to work on multiple related changes without waiting for
210them to land, you can do so in Gerrit using dependent changes.
211
212To put this into an example, let‘s say you have a commit for feature A
213and this is in the process of being reviewed on Gerrit. Now let’s say
214you want to start more work based on it before it lands on main.
215
216```
217git checkout featureA
218git checkout -b featureB
219git branch --set-upstream-to featureA
220# ... edit some files
221# ... git add ...
222git commit
223git cl upload
224```
225
226In Gerrit, there would then be a “relation chain” shown where the
227feature A change is the parent of the feature B change. If A
228introduces a new file which B changes, the review for B will only show
229the diff from A.
230
Daniel Cheng86135f32019-02-27 07:10:38231## Code review
232
233Code reviews are covered in more detail on the [code review
234policies][code-reviews] page.
235
236### Finding a reviewer
237
Ramzi Nbe25013d2023-11-02 00:47:53238Please note here that a "reviewer" in this context is someone that not
239only provides comment on the CL but also someone who can approve the
Erik Staab2e34edb2024-02-23 18:39:40240submission by providing a "Code-Review +1".
Daniel Cheng86135f32019-02-27 07:10:38241
Ramzi Nbe25013d2023-11-02 00:47:53242Reviewers must be [committers](https://www.chromium.org/getting-involved/become-a-committer/).
243Ideally they should be committers who are familiar with the area of code
244in question. If you're not sure who these should be, check with anyone in
245the nearest ancestor OWNERS file.
246
247- There must be at least one owner for each affected directory.
248- If there are multiple reviewers, make it clear what each reviewer is
249expected to review.
250- `git cl owners` automatically suggests reviewers based on the OWNERS
251files.
Daniel Cheng86135f32019-02-27 07:10:38252
Devlin Croninefe2e5872020-05-06 16:34:57253_Note:_ By default, please only select one reviewer for each file (that is, a
254single reviewer may review multiple files, but typically each file only needs
255to be reviewed by one person). It can be tempting to add multiple reviewers so
256that "whoever gets to it first" can review, but this has two common failure
257modes:
258- Reviewer Alpha and Beta both review the CL, resulting in duplicate effort.
259- Out of fear of the above failure case, neither reviewer Alpha nor Beta review
260 the CL.
261
262There are times when requesting multiple reviewers for the same file may be
263desirable - such as when the code is particularly complicated, or when the file
264uses multiple systems and a perspective from each is valuable. In this case,
265please make it explicit that you would like both reviewers to review.
266
Ramzi Nbe25013d2023-11-02 00:47:53267Submissions to the chromium/src repository by a change contributor who is
Erik Staab2e34edb2024-02-23 18:39:40268not a Chromium committer will require two committers to "Code-Review +1" the
Ramzi Nbe25013d2023-11-02 00:47:53269submissions. If the owner of the CL is already a committer, then only one
Erik Staab2e34edb2024-02-23 18:39:40270other committer is needed to "Code-Review +1".
Ramzi Nbe25013d2023-11-02 00:47:53271
Daniel Cheng86135f32019-02-27 07:10:38272### Requesting review
273
274Open the change on [the web][crrev]. If you can't find the link, running `git
275cl issue` will display the review URL for the current branch. Alternatively,
276visit <https://chromium-review.googlesource.com> and look in the "Outgoing
277Reviews" section.
278
279Reviewers expect to review code that compiles and passes tests. If you have
280access, now is a good time to run your change through the [automated
281tests](#running-automated-tests).
282
283Click **Add Reviewers** in the left column (if you don't see this link, make
284sure you are logged in). In the **Reviewers** field, enter a comma-separated
285list of the reviewers you picked.
286
287In the same dialog, you can include an optional message to your reviewers. This
288space can be used for specific questions or instructions. Once you're done,
Fredrik Söderquist53031aff2020-02-07 16:04:00289make sure to click **Start Review**, which notifies the requested reviewers that
290they should review your change.
Daniel Cheng86135f32019-02-27 07:10:38291
292**IMPORTANT: UNTIL YOU SEND THE REVIEW REQUEST, NO ONE WILL LOOK AT THE REVIEW**
293
294### Review process
295
296All changes must be reviewed (see [code review policies][code-reviews]).
297
298You should get a response within **one** business day; re-ping your reviewers
299if you do not.
300
301To upload new patch sets that address comments from the reviewers, simply
302commit more changes to your local branch and run `git cl upload` again.
303
304### Approval
305
306When the reviewer is happy with the change, they will set the "Code-Review +1"
307label. Owners of all affected files must approve before a change can be
308committed. See: [code review policies: owners][code-reviews-owners].
309
Erik Staab3d5a4b992024-03-20 16:33:57310All code review comments must be marked resolved before a CL can be committed.
311In some cases a reviewer may give "Code-Review +1" with some additional
312comments. These should be addressed and responded to, or at least acknowledged
313with the ACK button to resolve them. If you cannot resolve all comments an
314override is provided through an "Unresolved-Comment-Reason:" stanza in your
315commit message.
316
Daniel Cheng86135f32019-02-27 07:10:38317## Running automated tests
318
319Before being submitted, a change must pass the commit queue (CQ). The commit
320queue is an automated system which sends a patch to multiple try bots running
321different platforms: each try bot compiles Chromium with the patch and ensures
322the tests still pass on that platform.
323
324To trigger this process, click **CQ Dry Run** in the upper right corner of the
325code review tool. Note that this is equivalent to setting the "Commit-Queue +1"
326label. Anyone can set this label; however, the CQ will not process the patch
327unless the person setting the label has [try job access][try-job-access].
328
329If you don't have try job access and:
330
331- you have an @chromium.org email address, request access for yourself.
332- you have contributed a few patches, ask a reviewer to nominate you for access.
333- neither of the above is true, request that a reviewer run try jobs for you in
334 the code review request message.
335
336The status of the latest try job for a given patchset is visible just below the
337list of changed files. Each bot has its own bubble, using one of the following
338colors to indicate its status:
339
340- Gray: the bot has not started processing the patch yet.
341- Yellow: the run is in progress. Check back later!
342- Purple: the trybot encountered an exception while processing the patch.
343 Usually, this is not the fault of the patch. Try clicking **CQ Dry Run**
344 again.
345- Red: tests failed. Click on the failed bot to see what tests failed and why.
346- Green: the run passed!
347
348## Committing
349
Erik Staab2e34edb2024-02-23 18:39:40350Changes are committed via the [commit queue][commit-queue].
Daniel Cheng86135f32019-02-27 07:10:38351This is done by clicking **Submit to CQ** in the upper right corner, or setting
352the "Commit-Queue +2" label on the change. The commit queue will then
353send the patch to the try bots. If all try bots return green, the change will
354automatically be committed. Yay!
355
356Sometimes a test might be flaky. If you have an isolated failure that appears
357unrelated to your change, try sending the change to the commit queue again.
358
Erik Staab2e34edb2024-02-23 18:39:40359In emergencies, a developer with commit access can [directly
360commit][direct-commit] a change, bypassing the commit queue and all safety nets.
Daniel Cheng86135f32019-02-27 07:10:38361
Ben Pastene893979e2022-10-06 17:22:55362## Relanding a change
363
364Occasionally changes that pass the [commit queue][commit-queue] and get
365submitted into Chromium will later be reverted. If this happens to your change,
366don't be discouraged! This can be a common part of the Chromium development
367cycle and happens for a variety of reasons, including a conflict with an
368unanticipated change or tests not covered on the commit queue.
369
370If this happens to your change, you're encouraged to pursue a reland. When doing
371so, following these basic steps can streamline the re-review process:
372- **Create the reland**: Click the `CREATE RELAND` button on the original change
373 in Gerrit. This will create a new change whose diff is identical to the
374 original, but has a small paper-trail in the commit message that leads back to
375 the original. This can be useful for sheriffs when debugging regressions.
376- **Append the fix**: If the reland requires file modifications not present in
377 the original change, simply upload these fixes in a subsequent patchset to the
378 reland change. By comparing the first patchset with the latest, this gives
379 reviewers the ability to see the diff of _just_ the reland fix.
380- **Describe the fix**: In the commit message of the reland change, briefly
381 summarize what's changed that makes relanding again safe. Explanations can
382 include: "included needed fix", "disabled failing tests", "crash was fixed
383 elsewhere". Specifically for that last case: if the reland change is identical
384 to the original and the reland fix was handled separately in a preceding
385 change, make sure to link to that change in the commit message of the reland.
386
Darin Fisher0e196ee82019-09-06 22:39:12387## Code guidelines
388
389In addition to the adhering to the [styleguide][cr-styleguide], the following
390general rules of thumb can be helpful in navigating how to structure changes:
391
Darin Fisherf061fb12019-11-15 23:46:13392- **Code in the Chromium project should be in service of other code in the
393 Chromium project.** This is important so developers can understand the
394 constraints informing a design decision. Those constraints should be apparent
395 from the scope of code within the boundary of the project and its various
Peter Kasting54275102022-06-16 21:00:17396 repositories. In general, for each line of code, you should be able to find a
397 product in the Chromium repositories that depends on that line of code or else
398 the line of code should be removed.
Darin Fisher0e196ee82019-09-06 22:39:12399
Kentaro Harac196ba12022-09-26 07:57:33400 When you are adding support for a new OS, a new architecture, a new port or
401 a new top-level directory, please send an email to
John Abd-El-Malekba5d2782023-03-07 22:06:50402 [email protected] and get approval. For long-term maintenance
Kentaro Harac196ba12022-09-26 07:57:33403 reasons, we will accept only things that are used by the Chromium project
404 (including Chromium-supported projects like V8 and Skia) and things whose
405 benefit to Chromium outweighs any cost increase in maintaining Chromium's
406 supported architectures / platforms (e.g. adding one ifdef branch for an
407 unsupported architecture / platform has negligible cost and is likely fine,
408 but introducing new abstractions or changes to higher level directories has
409 a high cost and would need to provide Chromium with corresponding benefit).
410 Note that an unsupported architecture / platform will not have bots on
411 Google-managed waterfalls (even FYI bots) or maintained by Chromium
412 developers. Please use existing ifdef branches as much as possible.
Dirk Prankebfd0b6e2020-06-16 23:09:53413
Darin Fisher0e196ee82019-09-06 22:39:12414- **Code should only be moved to a central location (e.g., //base) when
415 multiple consumers would benefit.** We should resist the temptation to
416 build overly generic common libraries as that can lead to code bloat and
417 unnecessary complexity in common code.
418
419- **The code likely wasn't designed for everything we are trying to do with it
420 now.** Take time to refactor existing code to make sure the new feature or
421 subcomponent you are developing fits properly within the system. Technical
422 debt is easy to accumulate and is everyone's responsibility to avoid.
423
424- **Common code is everyone's responsibility.** Large files that are at the
425 cross-roads of many subsystems, where integration happens, can be some of the
426 most fragile in the system. As a companion to the previous point, be
427 cognizant of how you may be adding more complexity to the commons as you
428 venture to complete your task.
429
430- **Changes should include corresponding tests.** Automated testing is at the
431 heart of how we move forward as a project. All changes should include
432 corresponding tests so we can ensure that there is good coverage for code and
433 that future changes will be less likely to regress functionality. Protect
434 your code with tests!
435
Darin Fisher943fdf992020-10-29 18:02:50436- **Stick to the current set of supported languages as described in the
437 [styleguide][cr-styleguide].** While there is likely always a slightly better
438 tool for any particular job, maintainability of the codebase is paramount.
439 Reducing the number of languages eases toolchain and infrastructure
440 requirements, and minimizes the learning hurdles for developers to be
441 successful contributing across the codebase. Additions of new languages must
Takuto Ikuta9bc7d4ef2023-01-06 17:55:45442 be approved by [//ATL_OWNERS](../ATL_OWNERS).
Darin Fisher943fdf992020-10-29 18:02:50443
Kentaro Haradd8f7d702022-05-18 15:45:51444- **When your team is making API changes or migrating between services, the
445 team mandating the change needs to do at least 80% of the work.** The
446 rationale is to reduce externalities by having the team that requires a
447 change spend the vast majority of the time required to make it happen.
448 This naturally encourages designing to minimize the cost of change, be it
449 through automation, tooling, or pooled centralized expertise. You can find
450 more detailed rationale in [this doc](https://docs.google.com/document/d/1elJisUpOb3h4-7WA4Wn754nzfgeCJ4v2kAFvMOzNfek/edit#)
451 (Google internal). If you need an exception or help, please contact
452 [email protected].
453
Daniel Cheng86135f32019-02-27 07:10:38454## Tips
455
Dominik Röttschesd113bfa2019-07-10 08:56:24456### Review etiquette
457
Daniel Cheng86135f32019-02-27 07:10:38458During the lifetime of a review, you may want to rebase your change onto a newer
459source revision to minimize merge conflicts. The reviewer-friendly way to do
460this is to first address any unresolved comments and upload those changes as a
461patchset. Then, rebase to the newer revision and upload that as its own
462patchset (with no other changes). This makes it easy for reviewers to see the
463changes made in response to their comments, and then quickly verify the diffs
464from the rebase.
465
466Code authors and reviewers should keep in mind that Chromium is a global
467project: contributors and reviewers are often in time zones far apart. Please
468read these guidelines on [minimizing review lag][review-lag] and take them in
469consideration both when writing reviews and responding to review feedback.
470
Dominik Röttschesd113bfa2019-07-10 08:56:24471### Watchlists
472
473If you would like to be notified about changes to a set of files covering a
474topic or an area of Chromium, you may use the [watchlists][watchlist-doc]
475feature in order to receive email notifications.
476
Kalvin Lee23598832020-07-22 07:36:28477## Appendix: CL footer reference {#cl-footer-reference}
478
479Chromium stores a lot of information in footers at the bottom of commit
480messages. With the exception of `R=`, these footers are only valid in the
481last paragraph of a commit message; any footers separated from the last
482line of the message by whitespace or non-footer lines will be ignored.
483This includes everything from the unique `Change-Id` which identifies a
484Gerrit change, to more useful metadata like bugs the change helps fix,
485trybots which should be run to test the change, and more. This section
486includes a listing of well-known footers, their meanings, and their
487formats.
488
489* **Bug:**
490 * A comma-separated list of bug references.
491 * A bug reference
492 * can be a bare number, e.g. `Bug: 123456`, or
493 * can specify a project and a number, e.g. `Bug: skia:1234`.
494 * On chromium-review, the default project is assumed to be `chromium`,
495 so all bugs in non-chromium projects on bugs.chromium.org should be
496 qualified by their project name.
497 * The Google-internal issue tracker is accessible by using the `b:`
498 project prefix.
499* **Fixed:** The same as `Bug:`, but will automatically close the
500 bug(s) as fixed when the CL lands.
501* **R=**
502 * This footer is _deprecated_ in the Chromium project; it was
503 deprecated when code review migrated to Gerrit. Instead, use
504 `-r [email protected]` when running `git cl upload`.
505 * A comma-separated list of reviewer email addresses (e.g.
506 [email protected], [email protected]).
Kalvin Lee23598832020-07-22 07:36:28507* **Cq-Include-Trybots:**
508 * A comma-separated list of trybots which should be triggered and
509 checked by the CQ in addition to the normal set.
L. David Baron08adb302021-12-13 14:23:43510 * Trybots are indicated in `bucket:builder` format (e.g.
511 `luci.chromium.try:android-asan`).
512 * The "Choose Tryjobs" UI in the "Checks" tab in Gerrit shows (and has
513 a button to copy) the Cq-Include-Trybots syntax for the currently
514 selected tryjobs.
Kalvin Lee23598832020-07-22 07:36:28515* **No-Presubmit:**
516 * If present, the value should always be the string `true`.
517 * Indicates to the CQ that it should not run presubmit checks on the CL.
518 * Used primarily on automated reverts.
519* **No-Try:**
520 * If present, the value should always be the string `true`.
521 * Indicates to the CQ that it should not start or check the results of
522 any tryjobs.
523 * Used primarily on automated reverts.
524* **No-Tree-Checks:**
525 * If present, the value should always be the string `true`.
526 * Indicates to the CQ that it should ignore the tree status and submit
527 the change even to a closed tree.
528 * Used primarily on automated reverts.
529* **Test:**
530 * A freeform description of manual testing performed on the change.
531 * Not necessary if all testing is covered by trybots.
532* **Reviewed-by:**
533 * Automatically added by Gerrit when a change is submitted.
534 * Lists the names and email addresses of the people who approved
535 (set the `Code-Review` label on) the change prior to submission.
536* **Reviewed-on:**
537 * Automatically added by Gerrit when a change is submitted.
538 * Links back to the code review page for easy access to comment and
539 patch set history.
540* **Change-Id:**
541 * Automatically added by `git cl upload`.
542 * A unique ID that helps Gerrit keep track of commits that are part of
543 the same code review.
544* **Cr-Commit-Position:**
545 * Automatically added by the git-numberer Gerrit plugin when a change
546 is submitted.
547 * This is of the format `fully/qualified/ref@{#123456}` and gives both
548 the branch name and "sequence number" along that branch.
549 * This approximates an SVN-style monotonically increasing revision
550 number.
551* **Cr-Branched-From:**
552 * Automatically added by the git-numberer Gerrit plugin on changes
Emily Stark84d57192021-05-14 18:58:25553 which are submitted to non-main branches.
554 * Aids those reading a non-main branch history in finding when a
555 given commit diverged from main.
Dominik Röttschesd113bfa2019-07-10 08:56:24556
Daniel Cheng86135f32019-02-27 07:10:38557[//]: # (the reference link section should be alphabetically sorted)
John Palmer046f9872021-05-24 01:24:56558[checkout-and-build]: https://chromium.googlesource.com/chromium/src/+/main/docs/#checking-out-and-building
John Abd-El-Malek27e1cf02019-12-18 17:35:18559[chrome-dd-review-process]: http://go/chrome-dd-review-process
560[chromium-design-docs]: https://groups.google.com/a/chromium.org/forum/#!forum/chromium-design-docs
Daniel Cheng86135f32019-02-27 07:10:38561[code-reviews-owners]: code_reviews.md#OWNERS-files
562[code-reviews]: code_reviews.md
Toby Huang5105f812019-08-08 23:47:57563[commit-checklist]: commit_checklist.md
Daniel Cheng86135f32019-02-27 07:10:38564[commit-queue]: infra/cq.md
565[core-principles]: https://www.chromium.org/developers/core-principles
566[corporate-cla]: https://cla.developers.google.com/about/google-corporate?csw=1
567[cr-authors]: https://chromium.googlesource.com/chromium/src/+/HEAD/AUTHORS
John Palmer046f9872021-05-24 01:24:56568[cr-styleguide]: https://chromium.googlesource.com/chromium/src/+/main/styleguide/styleguide.md
Daniel Cheng86135f32019-02-27 07:10:38569[crbug-new]: https://bugs.chromium.org/p/chromium/issues/entry
570[crbug]: https://bugs.chromium.org/p/chromium/issues/list
John Palmer046f9872021-05-24 01:24:56571[cros-authors]: https://chromium.googlesource.com/chromium/src/+/main/AUTHORS
572[cros-dev-guide]: https://chromium.googlesource.com/chromiumos/docs/+/main/developer_guide.md
Daniel Cheng86135f32019-02-27 07:10:38573[crrev]: https://chromium-review.googlesource.com
574[depot-tools-setup]: https://commondatastorage.googleapis.com/chrome-infra-docs/flat/depot_tools/docs/html/depot_tools_tutorial.html#_setting_up
John Abd-El-Malek27e1cf02019-12-18 17:35:18575[design-doc-template]: https://docs.google.com/document/d/14YBYKgk-uSfjfwpKFlp_omgUq5hwMVazy_M965s_1KA
Daniel Cheng86135f32019-02-27 07:10:38576[direct-commit]: https://dev.chromium.org/developers/contributing-code/direct-commit
577[discussion-groups]: https://www.chromium.org/developers/discussion-groups
578[github-tutorial]: https://try.github.io
579[good-git-commit-message]: https://chris.beams.io/posts/git-commit/
580[individual-cla]: https://cla.developers.google.com/about/google-individual?csw=1
Daniel Cheng737635ba2021-11-05 15:25:46581[life-of-a-chromium-developer]: https://docs.google.com/presentation/d/1abnqM9j6zFodPHA38JG1061rG2iGj_GABxEDgZsdbJg/edit
Daniel Cheng86135f32019-02-27 07:10:38582[noms-tutorial]: https://meowni.ca/posts/chromium-101
583[review-lag]: https://dev.chromium.org/developers/contributing-code/minimizing-review-lag-across-time-zones
Nourhan Hasan571a2f22024-07-26 16:50:48584[skia-dev-guide]: https://skia.org/docs/dev/contrib/
Daniel Cheng86135f32019-02-27 07:10:38585[try-job-access]: https://www.chromium.org/getting-involved/become-a-committer#TOC-Try-job-access
586[v8-dev-guide]: https://v8.dev/docs
Dominik Röttschesd113bfa2019-07-10 08:56:24587[watchlist-doc]: infra/watchlists.md