Fuchsia manages commits through Gerrit at https://fuchsia-review.googlesource.com. Not all projects accept patches; please see the CONTRIBUTING.md document in individual projects for details.
To submit a patch to Fuchsia, you may first need to generate a cookie to authenticate you to Gerrit. To generate a cookie, log into Gerrit and click the "Generate Password" link at the top of https://fuchsia.googlesource.com. Then, copy the generated text and execute it in a terminal.
Once authenticated, follow these steps to submit a patch to a repo in Fuchsia:
# create a new branch
git checkout -b branch_name
# write some awesome stuff, commit to branch_name
# edit some_file ...
git add some_file
# if specified in the repo, follow the commit message format
git commit ...
# upload the patch to Gerrit
# `jiri help upload` lists flags for various features, e.g. adding reviewers
jiri upload # Adds default topic - ${USER}-branch_name
# or
jiri upload -topic="custom_topic"
# or
git push origin HEAD:refs/for/master
# at any time, if you'd like to make changes to your patch, use --amend
git commit --amend
# once the change is landed, clean up the branch
git branch -d branch_name
See the Gerrit documentation for more detail: https://gerrit-documentation.storage.googleapis.com/Documentation/2.12.3/intro-user.html#upload-change
If submitting a change to Zircon, Garnet, Peridot or Topaz, include [tags] in the commit subject flagging which module, library, app, etc, is affected by the change. The style here is somewhat informal. Look at these example changes to get a feel for how these are used.
- https://fuchsia-review.googlesource.com/c/zircon/+/112976
- https://fuchsia-review.googlesource.com/c/garnet/+/110795
- https://fuchsia-review.googlesource.com/c/peridot/+/113955
- https://fuchsia-review.googlesource.com/c/topaz/+/114013
Gerrit will flag your change with
Needs Label: Commit-Message-has-tags if these are missing.
Example:
# Ready to submit
[parent][component] Update component in Topaz.
Test: Added test X
# Needs Label: Commit-Message-has-tags
Update component in Topaz.
Test: Added test X
Changes to Zircon, Garnet, Peridot, and Topaz require a "Test:" line in the commit message.
We normally expect all changes that modify behavior to include a test that demonstrates (some aspect of) the behavior change. The test label should name the test that was added or modified by the change:
Test: SandboxMetadata.ParseRapidJson
Some behavior changes are not appropriate to test in an automated fashion. In those cases, the test label should describe the manual testing performed by the author:
Test: Manually tested that the keyboard still worked after unplugging and
replugging the USB connector.
In some cases, we are not able to test certain behavior changes because we lack some particular piece of infrastructure. In that case, we should have an issue in the tracker about creating that infrastructure and the test label should mention the bug number in addition to describing how the change was manually tested:
Test: Manually tested that [...]. Automated testing needs US-XXXX
If the change does not change behavior, the test line should indicate that you did not intend to change any behavior:
Test: No behavior change
If there's a test suite that validates that your change did not change behavior, you can mention that test suite as well:
Test: blobfs-test
Alternatively, if the change involves updating a dependency for which the commit queue should provide appropriate acceptance testing, the test label should defer to the commit queue:
Test: CQ
Syntactically, commit messages must contain one of {test, tests, tested, testing} followed by ':' or '='. Any case (e.g., "TEST" or "Test") works.
All of these are valid:
TEST=msg
Test:msg
Testing : msg
Tested = msg
Tests:
- test a
- test b
(See https://fuchsia.googlesource.com/All-Projects/+/refs/meta/config/rules.pl for the exact regex.)
Gerrit will flag your change with Needs Label: Commit-Message-has-TEST-line if
these are missing.
Example:
# Ready to submit
[parent][component] Update component in Topaz.
Test: Added test X
# Needs Label: Commit-Message-has-TEST-line
[parent][component] Update component in Topaz.
In order to land your change, you need to sign the Google CLA.
Commit messages may reference issue IDs in Fuchsia's issue tracker; such references will become links in the Gerrit UI. Issue actions may also be specified, for example to automatically close an issue when a commit is landed:
BUG-123 #done
done is the most common issue action, though any workflow action can be
indicated in this way.
Issue actions take place when the relevant commit becomes visible in a Gerrit branch, with the exception that commits under refs/changes/ are ignored. Usually, this means the action will happen when the commit is merged to master, but note that it will also happen if a change is uploaded to a private branch.
Note: Fuchsia's issue tracker is not open to external contributors at this time.
Changes in two or more separate repos will be automatically tracked for you by Gerrit if you use the same topic.
Create branch with same name on all repos and upload the changes
# make and commit the first change
cd fuchsia/bin/fortune
git checkout -b add_feature_foo
* edit foo_related_files ... *
git add foo_related_files ...
git commit ...
# make and commit the second change in another repository
cd fuchsia/build
git checkout -b add_feature_foo
* edit more_foo_related_files ... *
git add more_foo_related_files ...
git commit ...
# Upload all changes with the same branch name across repos
jiri upload -multipart # Adds default topic - ${USER}-branch_name
# or
jiri upload -multipart -topic="custom_topic"
# after the changes are reviewed, approved and submitted, clean up the local branch
cd fuchsia/bin/fortune
git branch -d add_feature_foo
cd fuchsia/build
git branch -d add_feature_foo
# make and commit the first change, upload it with topic 'add_feature_foo'
cd fuchsia/bin/fortune
git checkout -b add_feature_foo
* edit foo_related_files ... *
git add foo_related_files ...
git commit ...
git push origin HEAD:refs/for/master%topic=add_feature_foo
# make and commit the second change in another repository
cd fuchsia/build
git checkout -b add_feature_foo
* edit more_foo_related_files ... *
git add more_foo_related_files ...
git commit ...
git push origin HEAD:refs/for/master%topic=add_feature_foo
# after the changes are reviewed, approved and submitted, clean up the local branch
cd fuchsia/bin/fortune
git branch -d add_feature_foo
cd fuchsia/build
git branch -d add_feature_foo
Multipart changes are tracked in Gerrit via topics, will be tested together,
and can be landed in Gerrit at the same time with Submit Whole Topic. Topics
can be edited via the web UI.
See Changes that span repositories.
# rebase from origin/master, revealing the merge conflict
git rebase origin/master
# resolve the conflicts and complete the rebase
* edit files_with_conflicts ... *
git add files_with_resolved_conflicts ...
git rebase --continue
jiri upload
# continue as usual
git commit --amend
jiri upload
While Fuchsia's code is hosted at https://fuchsia.googlesource.com, it is also mirrored to https://github.com/fuchsia-mirror. To ensure Fuchsia contributions are associated with your Github account:
- Set your email in Git.
- Adding your email address to your GitHub account.
- Star the project for your contributions to show up in your profile's Contribution Activity.