blob: d4d705a6bb207e39b31315c3d543f1d4cf393a06 [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
Toby Huang5105f812019-08-08 23:47:57136Note: go through the [commit checklist][commit-checklist] for Chromium before
137uploading a change for review.
138
Daniel Cheng86135f32019-02-27 07:10:38139Chromium uses a Gerrit instance hosted at
140<https://chromium-review.googlesource.com> for code reviews. In order to upload
141your local change to Gerrit, use `git-cl` from
142[depot\_tools][depot-tools-setup] to create a new Gerrit change, based on the
143diff between the current branch and its upstream branch:
144
145```
146git cl upload
147```
148
149This will open a text editor to create a description for the new change. This
150description will be used as the commit message when the change is landed in the
151Chromium tree. Descriptions should be formatted as follows:
152
153```
154Summary of change (one line)
155
156Longer description of change addressing as appropriate: why the change
157is made, context if it is part of many changes, description of previous
158behavior and newly introduced differences, etc.
159
160Long lines should be wrapped to 72 columns for easier log message
161viewing in terminals.
162
163Bug: 123456
164```
165
166A short subject and a blank line after the subject are crucial: `git` uses this
167as a heuristic for tools like `git log --oneline`. Use the bug number from the
Kalvin Lee23598832020-07-22 07:36:28168[issue tracker][crbug] (see more on [CL footer syntax](#cl-footer-reference)).
169Also see [How to Write a Git Commit Message][good-git-commit-message], which
170has more in-depth tips for writing a good commit description.
Daniel Cheng86135f32019-02-27 07:10:38171
172### Chromium-specific description tips
173
174- Links to previous CLs should be formatted as `https://crrev.com/c/NUMBER`,
Kalvin Lee313a7f22022-08-22 08:20:45175 which is slightly shorter than <https://chromium-review.googlesource.com>.
Daniel Cheng86135f32019-02-27 07:10:38176
177- If there are instructions for testers to verify the change is correct,
178 include them with the `Test:` tag:
179
180 ```
181 Test: Load example.com/page.html and click the foo-button; see
182 crbug.com/123456 for more details.
183 ```
184
185After saving the change description, `git-cl` runs some presubmit scripts to
186check for common errors. If everything passes, `git-cl` will print something
187like this:
188
189```
190remote: SUCCESS
191remote:
192remote: New Changes:
193remote: https://chromium-review.googlesource.com/c/chromium/src/+/1485699 Use base::TimeDelta::FromTimeSpec helper in more places. [WIP]
194```
195
196Additional flags can be used to specify reviewers, bugs fixed by the change, et
197cetera:
198
199```
200git cl upload -r [email protected],[email protected] -b 123456
201```
202
203See `git cl help upload` for a full list of flags.
204
Andrea Orru771255242023-02-27 02:41:28205### Uploading dependent changes
206
207If you wish to work on multiple related changes without waiting for
208them to land, you can do so in Gerrit using dependent changes.
209
210To put this into an example, let‘s say you have a commit for feature A
211and this is in the process of being reviewed on Gerrit. Now let’s say
212you want to start more work based on it before it lands on main.
213
214```
215git checkout featureA
216git checkout -b featureB
217git branch --set-upstream-to featureA
218# ... edit some files
219# ... git add ...
220git commit
221git cl upload
222```
223
224In Gerrit, there would then be a “relation chain” shown where the
225feature A change is the parent of the feature B change. If A
226introduces a new file which B changes, the review for B will only show
227the diff from A.
228
Daniel Cheng86135f32019-02-27 07:10:38229## Code review
230
231Code reviews are covered in more detail on the [code review
232policies][code-reviews] page.
233
234### Finding a reviewer
235
Ramzi Nbe25013d2023-11-02 00:47:53236Please note here that a "reviewer" in this context is someone that not
237only provides comment on the CL but also someone who can approve the
Erik Staab2e34edb2024-02-23 18:39:40238submission by providing a "Code-Review +1".
Daniel Cheng86135f32019-02-27 07:10:38239
Ramzi Nbe25013d2023-11-02 00:47:53240Reviewers must be [committers](https://www.chromium.org/getting-involved/become-a-committer/).
241Ideally they should be committers who are familiar with the area of code
242in question. If you're not sure who these should be, check with anyone in
243the nearest ancestor OWNERS file.
244
245- There must be at least one owner for each affected directory.
246- If there are multiple reviewers, make it clear what each reviewer is
247expected to review.
248- `git cl owners` automatically suggests reviewers based on the OWNERS
249files.
Daniel Cheng86135f32019-02-27 07:10:38250
Devlin Croninefe2e5872020-05-06 16:34:57251_Note:_ By default, please only select one reviewer for each file (that is, a
252single reviewer may review multiple files, but typically each file only needs
253to be reviewed by one person). It can be tempting to add multiple reviewers so
254that "whoever gets to it first" can review, but this has two common failure
255modes:
256- Reviewer Alpha and Beta both review the CL, resulting in duplicate effort.
257- Out of fear of the above failure case, neither reviewer Alpha nor Beta review
258 the CL.
259
260There are times when requesting multiple reviewers for the same file may be
261desirable - such as when the code is particularly complicated, or when the file
262uses multiple systems and a perspective from each is valuable. In this case,
263please make it explicit that you would like both reviewers to review.
264
Ramzi Nbe25013d2023-11-02 00:47:53265Submissions to the chromium/src repository by a change contributor who is
Erik Staab2e34edb2024-02-23 18:39:40266not a Chromium committer will require two committers to "Code-Review +1" the
Ramzi Nbe25013d2023-11-02 00:47:53267submissions. If the owner of the CL is already a committer, then only one
Erik Staab2e34edb2024-02-23 18:39:40268other committer is needed to "Code-Review +1".
Ramzi Nbe25013d2023-11-02 00:47:53269
Daniel Cheng86135f32019-02-27 07:10:38270### Requesting review
271
272Open the change on [the web][crrev]. If you can't find the link, running `git
273cl issue` will display the review URL for the current branch. Alternatively,
274visit <https://chromium-review.googlesource.com> and look in the "Outgoing
275Reviews" section.
276
277Reviewers expect to review code that compiles and passes tests. If you have
278access, now is a good time to run your change through the [automated
279tests](#running-automated-tests).
280
281Click **Add Reviewers** in the left column (if you don't see this link, make
282sure you are logged in). In the **Reviewers** field, enter a comma-separated
283list of the reviewers you picked.
284
285In the same dialog, you can include an optional message to your reviewers. This
286space can be used for specific questions or instructions. Once you're done,
Fredrik Söderquist53031aff2020-02-07 16:04:00287make sure to click **Start Review**, which notifies the requested reviewers that
288they should review your change.
Daniel Cheng86135f32019-02-27 07:10:38289
290**IMPORTANT: UNTIL YOU SEND THE REVIEW REQUEST, NO ONE WILL LOOK AT THE REVIEW**
291
292### Review process
293
294All changes must be reviewed (see [code review policies][code-reviews]).
295
296You should get a response within **one** business day; re-ping your reviewers
297if you do not.
298
299To upload new patch sets that address comments from the reviewers, simply
300commit more changes to your local branch and run `git cl upload` again.
301
302### Approval
303
304When the reviewer is happy with the change, they will set the "Code-Review +1"
305label. Owners of all affected files must approve before a change can be
306committed. See: [code review policies: owners][code-reviews-owners].
307
Erik Staab3d5a4b992024-03-20 16:33:57308All code review comments must be marked resolved before a CL can be committed.
309In some cases a reviewer may give "Code-Review +1" with some additional
310comments. These should be addressed and responded to, or at least acknowledged
311with the ACK button to resolve them. If you cannot resolve all comments an
312override is provided through an "Unresolved-Comment-Reason:" stanza in your
313commit message.
314
Daniel Cheng86135f32019-02-27 07:10:38315## Running automated tests
316
317Before being submitted, a change must pass the commit queue (CQ). The commit
318queue is an automated system which sends a patch to multiple try bots running
319different platforms: each try bot compiles Chromium with the patch and ensures
320the tests still pass on that platform.
321
322To trigger this process, click **CQ Dry Run** in the upper right corner of the
323code review tool. Note that this is equivalent to setting the "Commit-Queue +1"
324label. Anyone can set this label; however, the CQ will not process the patch
325unless the person setting the label has [try job access][try-job-access].
326
327If you don't have try job access and:
328
329- you have an @chromium.org email address, request access for yourself.
330- you have contributed a few patches, ask a reviewer to nominate you for access.
331- neither of the above is true, request that a reviewer run try jobs for you in
332 the code review request message.
333
334The status of the latest try job for a given patchset is visible just below the
335list of changed files. Each bot has its own bubble, using one of the following
336colors to indicate its status:
337
338- Gray: the bot has not started processing the patch yet.
339- Yellow: the run is in progress. Check back later!
340- Purple: the trybot encountered an exception while processing the patch.
341 Usually, this is not the fault of the patch. Try clicking **CQ Dry Run**
342 again.
343- Red: tests failed. Click on the failed bot to see what tests failed and why.
344- Green: the run passed!
345
346## Committing
347
Erik Staab2e34edb2024-02-23 18:39:40348Changes are committed via the [commit queue][commit-queue].
Daniel Cheng86135f32019-02-27 07:10:38349This is done by clicking **Submit to CQ** in the upper right corner, or setting
350the "Commit-Queue +2" label on the change. The commit queue will then
351send the patch to the try bots. If all try bots return green, the change will
352automatically be committed. Yay!
353
354Sometimes a test might be flaky. If you have an isolated failure that appears
355unrelated to your change, try sending the change to the commit queue again.
356
Erik Staab2e34edb2024-02-23 18:39:40357In emergencies, a developer with commit access can [directly
358commit][direct-commit] a change, bypassing the commit queue and all safety nets.
Daniel Cheng86135f32019-02-27 07:10:38359
Ben Pastene893979e2022-10-06 17:22:55360## Relanding a change
361
362Occasionally changes that pass the [commit queue][commit-queue] and get
363submitted into Chromium will later be reverted. If this happens to your change,
364don't be discouraged! This can be a common part of the Chromium development
365cycle and happens for a variety of reasons, including a conflict with an
366unanticipated change or tests not covered on the commit queue.
367
368If this happens to your change, you're encouraged to pursue a reland. When doing
369so, following these basic steps can streamline the re-review process:
370- **Create the reland**: Click the `CREATE RELAND` button on the original change
371 in Gerrit. This will create a new change whose diff is identical to the
372 original, but has a small paper-trail in the commit message that leads back to
373 the original. This can be useful for sheriffs when debugging regressions.
374- **Append the fix**: If the reland requires file modifications not present in
375 the original change, simply upload these fixes in a subsequent patchset to the
376 reland change. By comparing the first patchset with the latest, this gives
377 reviewers the ability to see the diff of _just_ the reland fix.
378- **Describe the fix**: In the commit message of the reland change, briefly
379 summarize what's changed that makes relanding again safe. Explanations can
380 include: "included needed fix", "disabled failing tests", "crash was fixed
381 elsewhere". Specifically for that last case: if the reland change is identical
382 to the original and the reland fix was handled separately in a preceding
383 change, make sure to link to that change in the commit message of the reland.
384
Darin Fisher0e196ee82019-09-06 22:39:12385## Code guidelines
386
387In addition to the adhering to the [styleguide][cr-styleguide], the following
388general rules of thumb can be helpful in navigating how to structure changes:
389
Darin Fisherf061fb12019-11-15 23:46:13390- **Code in the Chromium project should be in service of other code in the
391 Chromium project.** This is important so developers can understand the
392 constraints informing a design decision. Those constraints should be apparent
393 from the scope of code within the boundary of the project and its various
Peter Kasting54275102022-06-16 21:00:17394 repositories. In general, for each line of code, you should be able to find a
395 product in the Chromium repositories that depends on that line of code or else
396 the line of code should be removed.
Darin Fisher0e196ee82019-09-06 22:39:12397
Kentaro Harac196ba12022-09-26 07:57:33398 When you are adding support for a new OS, a new architecture, a new port or
399 a new top-level directory, please send an email to
John Abd-El-Malekba5d2782023-03-07 22:06:50400 [email protected] and get approval. For long-term maintenance
Kentaro Harac196ba12022-09-26 07:57:33401 reasons, we will accept only things that are used by the Chromium project
402 (including Chromium-supported projects like V8 and Skia) and things whose
403 benefit to Chromium outweighs any cost increase in maintaining Chromium's
404 supported architectures / platforms (e.g. adding one ifdef branch for an
405 unsupported architecture / platform has negligible cost and is likely fine,
406 but introducing new abstractions or changes to higher level directories has
407 a high cost and would need to provide Chromium with corresponding benefit).
408 Note that an unsupported architecture / platform will not have bots on
409 Google-managed waterfalls (even FYI bots) or maintained by Chromium
410 developers. Please use existing ifdef branches as much as possible.
Dirk Prankebfd0b6e2020-06-16 23:09:53411
Darin Fisher0e196ee82019-09-06 22:39:12412- **Code should only be moved to a central location (e.g., //base) when
413 multiple consumers would benefit.** We should resist the temptation to
414 build overly generic common libraries as that can lead to code bloat and
415 unnecessary complexity in common code.
416
417- **The code likely wasn't designed for everything we are trying to do with it
418 now.** Take time to refactor existing code to make sure the new feature or
419 subcomponent you are developing fits properly within the system. Technical
420 debt is easy to accumulate and is everyone's responsibility to avoid.
421
422- **Common code is everyone's responsibility.** Large files that are at the
423 cross-roads of many subsystems, where integration happens, can be some of the
424 most fragile in the system. As a companion to the previous point, be
425 cognizant of how you may be adding more complexity to the commons as you
426 venture to complete your task.
427
428- **Changes should include corresponding tests.** Automated testing is at the
429 heart of how we move forward as a project. All changes should include
430 corresponding tests so we can ensure that there is good coverage for code and
431 that future changes will be less likely to regress functionality. Protect
432 your code with tests!
433
Darin Fisher943fdf992020-10-29 18:02:50434- **Stick to the current set of supported languages as described in the
435 [styleguide][cr-styleguide].** While there is likely always a slightly better
436 tool for any particular job, maintainability of the codebase is paramount.
437 Reducing the number of languages eases toolchain and infrastructure
438 requirements, and minimizes the learning hurdles for developers to be
439 successful contributing across the codebase. Additions of new languages must
Takuto Ikuta9bc7d4ef2023-01-06 17:55:45440 be approved by [//ATL_OWNERS](../ATL_OWNERS).
Darin Fisher943fdf992020-10-29 18:02:50441
Kentaro Haradd8f7d702022-05-18 15:45:51442- **When your team is making API changes or migrating between services, the
443 team mandating the change needs to do at least 80% of the work.** The
444 rationale is to reduce externalities by having the team that requires a
445 change spend the vast majority of the time required to make it happen.
446 This naturally encourages designing to minimize the cost of change, be it
447 through automation, tooling, or pooled centralized expertise. You can find
448 more detailed rationale in [this doc](https://docs.google.com/document/d/1elJisUpOb3h4-7WA4Wn754nzfgeCJ4v2kAFvMOzNfek/edit#)
449 (Google internal). If you need an exception or help, please contact
450 [email protected].
451
Daniel Cheng86135f32019-02-27 07:10:38452## Tips
453
Dominik Röttschesd113bfa2019-07-10 08:56:24454### Review etiquette
455
Daniel Cheng86135f32019-02-27 07:10:38456During the lifetime of a review, you may want to rebase your change onto a newer
457source revision to minimize merge conflicts. The reviewer-friendly way to do
458this is to first address any unresolved comments and upload those changes as a
459patchset. Then, rebase to the newer revision and upload that as its own
460patchset (with no other changes). This makes it easy for reviewers to see the
461changes made in response to their comments, and then quickly verify the diffs
462from the rebase.
463
464Code authors and reviewers should keep in mind that Chromium is a global
465project: contributors and reviewers are often in time zones far apart. Please
466read these guidelines on [minimizing review lag][review-lag] and take them in
467consideration both when writing reviews and responding to review feedback.
468
Dominik Röttschesd113bfa2019-07-10 08:56:24469### Watchlists
470
471If you would like to be notified about changes to a set of files covering a
472topic or an area of Chromium, you may use the [watchlists][watchlist-doc]
473feature in order to receive email notifications.
474
Kalvin Lee23598832020-07-22 07:36:28475## Appendix: CL footer reference {#cl-footer-reference}
476
477Chromium stores a lot of information in footers at the bottom of commit
478messages. With the exception of `R=`, these footers are only valid in the
479last paragraph of a commit message; any footers separated from the last
480line of the message by whitespace or non-footer lines will be ignored.
481This includes everything from the unique `Change-Id` which identifies a
482Gerrit change, to more useful metadata like bugs the change helps fix,
483trybots which should be run to test the change, and more. This section
484includes a listing of well-known footers, their meanings, and their
485formats.
486
487* **Bug:**
488 * A comma-separated list of bug references.
489 * A bug reference
490 * can be a bare number, e.g. `Bug: 123456`, or
491 * can specify a project and a number, e.g. `Bug: skia:1234`.
492 * On chromium-review, the default project is assumed to be `chromium`,
493 so all bugs in non-chromium projects on bugs.chromium.org should be
494 qualified by their project name.
495 * The Google-internal issue tracker is accessible by using the `b:`
496 project prefix.
497* **Fixed:** The same as `Bug:`, but will automatically close the
498 bug(s) as fixed when the CL lands.
499* **R=**
500 * This footer is _deprecated_ in the Chromium project; it was
501 deprecated when code review migrated to Gerrit. Instead, use
502 `-r [email protected]` when running `git cl upload`.
503 * A comma-separated list of reviewer email addresses (e.g.
504 [email protected], [email protected]).
Kalvin Lee23598832020-07-22 07:36:28505* **Cq-Include-Trybots:**
506 * A comma-separated list of trybots which should be triggered and
507 checked by the CQ in addition to the normal set.
L. David Baron08adb302021-12-13 14:23:43508 * Trybots are indicated in `bucket:builder` format (e.g.
509 `luci.chromium.try:android-asan`).
510 * The "Choose Tryjobs" UI in the "Checks" tab in Gerrit shows (and has
511 a button to copy) the Cq-Include-Trybots syntax for the currently
512 selected tryjobs.
Kalvin Lee23598832020-07-22 07:36:28513* **No-Presubmit:**
514 * If present, the value should always be the string `true`.
515 * Indicates to the CQ that it should not run presubmit checks on the CL.
516 * Used primarily on automated reverts.
517* **No-Try:**
518 * If present, the value should always be the string `true`.
519 * Indicates to the CQ that it should not start or check the results of
520 any tryjobs.
521 * Used primarily on automated reverts.
522* **No-Tree-Checks:**
523 * If present, the value should always be the string `true`.
524 * Indicates to the CQ that it should ignore the tree status and submit
525 the change even to a closed tree.
526 * Used primarily on automated reverts.
527* **Test:**
528 * A freeform description of manual testing performed on the change.
529 * Not necessary if all testing is covered by trybots.
530* **Reviewed-by:**
531 * Automatically added by Gerrit when a change is submitted.
532 * Lists the names and email addresses of the people who approved
533 (set the `Code-Review` label on) the change prior to submission.
534* **Reviewed-on:**
535 * Automatically added by Gerrit when a change is submitted.
536 * Links back to the code review page for easy access to comment and
537 patch set history.
538* **Change-Id:**
539 * Automatically added by `git cl upload`.
540 * A unique ID that helps Gerrit keep track of commits that are part of
541 the same code review.
542* **Cr-Commit-Position:**
543 * Automatically added by the git-numberer Gerrit plugin when a change
544 is submitted.
545 * This is of the format `fully/qualified/ref@{#123456}` and gives both
546 the branch name and "sequence number" along that branch.
547 * This approximates an SVN-style monotonically increasing revision
548 number.
549* **Cr-Branched-From:**
550 * Automatically added by the git-numberer Gerrit plugin on changes
Emily Stark84d57192021-05-14 18:58:25551 which are submitted to non-main branches.
552 * Aids those reading a non-main branch history in finding when a
553 given commit diverged from main.
Dominik Röttschesd113bfa2019-07-10 08:56:24554
Daniel Cheng86135f32019-02-27 07:10:38555[//]: # (the reference link section should be alphabetically sorted)
John Palmer046f9872021-05-24 01:24:56556[checkout-and-build]: https://chromium.googlesource.com/chromium/src/+/main/docs/#checking-out-and-building
John Abd-El-Malek27e1cf02019-12-18 17:35:18557[chrome-dd-review-process]: http://go/chrome-dd-review-process
558[chromium-design-docs]: https://groups.google.com/a/chromium.org/forum/#!forum/chromium-design-docs
Daniel Cheng86135f32019-02-27 07:10:38559[code-reviews-owners]: code_reviews.md#OWNERS-files
560[code-reviews]: code_reviews.md
Toby Huang5105f812019-08-08 23:47:57561[commit-checklist]: commit_checklist.md
Daniel Cheng86135f32019-02-27 07:10:38562[commit-queue]: infra/cq.md
563[core-principles]: https://www.chromium.org/developers/core-principles
564[corporate-cla]: https://cla.developers.google.com/about/google-corporate?csw=1
565[cr-authors]: https://chromium.googlesource.com/chromium/src/+/HEAD/AUTHORS
John Palmer046f9872021-05-24 01:24:56566[cr-styleguide]: https://chromium.googlesource.com/chromium/src/+/main/styleguide/styleguide.md
Daniel Cheng86135f32019-02-27 07:10:38567[crbug-new]: https://bugs.chromium.org/p/chromium/issues/entry
568[crbug]: https://bugs.chromium.org/p/chromium/issues/list
John Palmer046f9872021-05-24 01:24:56569[cros-authors]: https://chromium.googlesource.com/chromium/src/+/main/AUTHORS
570[cros-dev-guide]: https://chromium.googlesource.com/chromiumos/docs/+/main/developer_guide.md
Daniel Cheng86135f32019-02-27 07:10:38571[crrev]: https://chromium-review.googlesource.com
572[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:18573[design-doc-template]: https://docs.google.com/document/d/14YBYKgk-uSfjfwpKFlp_omgUq5hwMVazy_M965s_1KA
Daniel Cheng86135f32019-02-27 07:10:38574[direct-commit]: https://dev.chromium.org/developers/contributing-code/direct-commit
575[discussion-groups]: https://www.chromium.org/developers/discussion-groups
576[github-tutorial]: https://try.github.io
577[good-git-commit-message]: https://chris.beams.io/posts/git-commit/
578[individual-cla]: https://cla.developers.google.com/about/google-individual?csw=1
Daniel Cheng737635ba2021-11-05 15:25:46579[life-of-a-chromium-developer]: https://docs.google.com/presentation/d/1abnqM9j6zFodPHA38JG1061rG2iGj_GABxEDgZsdbJg/edit
Daniel Cheng86135f32019-02-27 07:10:38580[noms-tutorial]: https://meowni.ca/posts/chromium-101
581[review-lag]: https://dev.chromium.org/developers/contributing-code/minimizing-review-lag-across-time-zones
582[skia-dev-guide]: https://skia.org/dev/contrib
583[try-job-access]: https://www.chromium.org/getting-involved/become-a-committer#TOC-Try-job-access
584[v8-dev-guide]: https://v8.dev/docs
Dominik Röttschesd113bfa2019-07-10 08:56:24585[watchlist-doc]: infra/watchlists.md