Improve formatting on "Contributing to Gerrit" page
- Use backticks around code, commands, and file names. - Use single quotes instead of double quotes when referring to menu names. - Use hyperlinks rather than bare http:// links - Refer to "topics" rather than "topic branches". - Fix a couple of typos. Change-Id: Ic279a7bbe3459cfa36886a24d2c8cbfc809d9048
This commit is contained in:
@@ -1,25 +1,26 @@
|
|||||||
= Gerrit Code Review - Contributing
|
= Gerrit Code Review - Contributing
|
||||||
|
|
||||||
== Introduction
|
== Introduction
|
||||||
Gerrit is developed as a self-hosting open source project and
|
Gerrit is developed as a
|
||||||
very much welcomes contributions from anyone with a contributor's
|
link:https://gerrit-review.googlesource.com/[self-hosting open source project]
|
||||||
|
and very much welcomes contributions from anyone with a contributor's
|
||||||
agreement on file with the project.
|
agreement on file with the project.
|
||||||
|
|
||||||
* https://gerrit-review.googlesource.com/
|
|
||||||
|
|
||||||
== Contributor License Agreement
|
== Contributor License Agreement
|
||||||
A Contributor License Agreement must be completed before contributions
|
A Contributor License Agreement must be completed before contributions
|
||||||
are accepted. To view and accept the agreements do the following:
|
are accepted. To view and accept the agreements do the following:
|
||||||
|
|
||||||
* Click "Sign In" at the top right corner of https://gerrit-review.googlesource.com/
|
* Click 'Sign In' at the top right corner of https://gerrit-review.googlesource.com/
|
||||||
* Sign In with your Google account
|
* Sign In with your Google account
|
||||||
* After signing in, go to https://gerrit-review.googlesource.com/#/settings/agreements
|
* After signing in, go to the
|
||||||
* Click "New Contributor Agreement" and follow the instructions
|
link:https://gerrit-review.googlesource.com/#/settings/agreements[Agreements]
|
||||||
|
tab on the settings page
|
||||||
|
* Click 'New Contributor Agreement' and follow the instructions
|
||||||
|
|
||||||
For reference, the actual agreements are linked below
|
For reference, the actual agreements are linked below
|
||||||
|
|
||||||
* https://cla.developers.google.com/about/android-individual
|
* link:https://cla.developers.google.com/about/android-individual[Individual Agreement]
|
||||||
* https://source.android.com/source/cla-corporate.pdf
|
* link:https://source.android.com/source/cla-corporate.pdf[Corporate Agreement]
|
||||||
|
|
||||||
== Code Review
|
== Code Review
|
||||||
As Gerrit is a code review tool, naturally contributions will
|
As Gerrit is a code review tool, naturally contributions will
|
||||||
@@ -28,9 +29,8 @@ start your contribution, please make a git commit and upload it
|
|||||||
for review to the main Gerrit review server. To help speed up the
|
for review to the main Gerrit review server. To help speed up the
|
||||||
review of your change, review these guidelines before submitting
|
review of your change, review these guidelines before submitting
|
||||||
your change. You can view the pending Gerrit contributions and
|
your change. You can view the pending Gerrit contributions and
|
||||||
their statuses here:
|
their statuses
|
||||||
|
link:https://gerrit-review.googlesource.com/#/q/status:open+project:gerrit[here].
|
||||||
* https://gerrit-review.googlesource.com/#/q/status:open+project:gerrit
|
|
||||||
|
|
||||||
Depending on the size of that list it might take a while for
|
Depending on the size of that list it might take a while for
|
||||||
your change to get reviewed. Naturally there are fewer
|
your change to get reviewed. Naturally there are fewer
|
||||||
@@ -78,13 +78,13 @@ change to be reviewed.
|
|||||||
* Followed by one or more explanatory paragraphs
|
* Followed by one or more explanatory paragraphs
|
||||||
* Use the present tense (fix instead of fixed)
|
* Use the present tense (fix instead of fixed)
|
||||||
* Use the past tense when describing the status before this commit
|
* Use the past tense when describing the status before this commit
|
||||||
* Include a Bug: Issue <#> line if fixing a Gerrit issue
|
* Include a `Bug: Issue <#>` line if fixing a Gerrit issue
|
||||||
* Include a Change-Id line
|
* Include a `Change-Id` line
|
||||||
|
|
||||||
=== Setting up Vim for Git commit message
|
=== Setting up Vim for Git commit message
|
||||||
|
|
||||||
Git uses Vim as the default commit message editor. Put this into your
|
Git uses Vim as the default commit message editor. Put this into your
|
||||||
$HOME/.vimrc file to configure Vim for Git commit message formatting
|
`$HOME/.vimrc` file to configure Vim for Git commit message formatting
|
||||||
and writing:
|
and writing:
|
||||||
|
|
||||||
====
|
====
|
||||||
@@ -114,8 +114,8 @@ and writing:
|
|||||||
Change-Id: Ic4a7c07eeb98cdeaf44e9d231a65a51f3fceae52
|
Change-Id: Ic4a7c07eeb98cdeaf44e9d231a65a51f3fceae52
|
||||||
====
|
====
|
||||||
|
|
||||||
The Change-Id is, as usual, created by a local git hook. To install it, simply
|
The `Change-Id` line is, as usual, created by a local git hook. To install it,
|
||||||
copy it from the checkout and make it executable:
|
simply copy it from the checkout and make it executable:
|
||||||
|
|
||||||
====
|
====
|
||||||
cp ./gerrit-server/src/main/resources/com/google/gerrit/server/tools/root/hooks/commit-msg .git/hooks/
|
cp ./gerrit-server/src/main/resources/com/google/gerrit/server/tools/root/hooks/commit-msg .git/hooks/
|
||||||
@@ -138,7 +138,7 @@ To set up git's remote for easy pushing, run the following:
|
|||||||
====
|
====
|
||||||
|
|
||||||
The HTTPS access requires proper username and password; this can be obtained
|
The HTTPS access requires proper username and password; this can be obtained
|
||||||
by clicking the "Obtain Password" link on the
|
by clicking the 'Obtain Password' link on the
|
||||||
link:https://gerrit-review.googlesource.com/#/settings/http-password[HTTP
|
link:https://gerrit-review.googlesource.com/#/settings/http-password[HTTP
|
||||||
Password tab of the user settings page].
|
Password tab of the user settings page].
|
||||||
|
|
||||||
@@ -219,8 +219,8 @@ Here are some guidelines that Gerrit uses:
|
|||||||
be near each other barring a good reason not to.
|
be near each other barring a good reason not to.
|
||||||
* If you are using assisted injection, the factory for your class
|
* If you are using assisted injection, the factory for your class
|
||||||
should be before the instance members.
|
should be before the instance members.
|
||||||
* Annotations should go before language keywords (final, private...) +
|
* Annotations should go before language keywords (`final`, `private`, etc) +
|
||||||
Example: @Assisted @Nullable final type varName
|
Example: `@Assisted @Nullable final type varName`
|
||||||
* Imports should be mostly alphabetical (uppercase sorts before
|
* Imports should be mostly alphabetical (uppercase sorts before
|
||||||
all lowercase, which means classes come before packages at the
|
all lowercase, which means classes come before packages at the
|
||||||
same level).
|
same level).
|
||||||
@@ -251,7 +251,7 @@ when coding:
|
|||||||
mitigating this longer load by using a second RPC to fill in
|
mitigating this longer load by using a second RPC to fill in
|
||||||
this data after the page is displayed (or alternatively it might
|
this data after the page is displayed (or alternatively it might
|
||||||
be worth proposing caching this data).
|
be worth proposing caching this data).
|
||||||
* @Inject should be used on constructors, not on fields. The
|
* `@Inject` should be used on constructors, not on fields. The
|
||||||
current exceptions are the ssh commands, these were implemented
|
current exceptions are the ssh commands, these were implemented
|
||||||
earlier in Gerrit's development. To stay consistent, new ssh
|
earlier in Gerrit's development. To stay consistent, new ssh
|
||||||
commands should follow this older pattern; but eventually these
|
commands should follow this older pattern; but eventually these
|
||||||
@@ -305,9 +305,9 @@ especially if changing one without the other will break something!
|
|||||||
* Do only what the commit message describes. In other words, things which
|
* Do only what the commit message describes. In other words, things which
|
||||||
are not strictly related to the commit message shouldn't be part of
|
are not strictly related to the commit message shouldn't be part of
|
||||||
a change, even trivial things like externalizing a string somewhere
|
a change, even trivial things like externalizing a string somewhere
|
||||||
or fixing a typo. This help keep "git blame" more useful in the future
|
or fixing a typo. This helps keep `git blame` more useful in the future
|
||||||
and it also makes "git revert" more useful.
|
and it also makes `git revert` more useful.
|
||||||
* Use topic branches to link your separate changes together.
|
* Use topics to link your separate changes together.
|
||||||
|
|
||||||
[[process]]
|
[[process]]
|
||||||
== Process
|
== Process
|
||||||
|
|||||||
Reference in New Issue
Block a user