Skip to content

Commit 221c63e

Browse files
committed
[FAB-9283] Various wording improvements in changes.rst
Corrections in changes.rst include: - specify correct subject line length of 55 characters - lots of grammar/wording issues Change-Id: I27b70f493c1ab83d28fec396c7331368f28c19ed Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
1 parent cc8b0a0 commit 221c63e

File tree

1 file changed

+36
-37
lines changed

1 file changed

+36
-37
lines changed

docs/source/Gerrit/changes.rst

+36-37
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,68 @@
11
Submitting a Change to Gerrit
22
=============================
33

4-
Carefully review the following before submitting a change. These
5-
guidelines apply to developers that are new to open source, as well as
6-
to experienced open source developers.
4+
Carefully review the following before submitting a change to the
5+
Hyperledger Fabric code base. These guidelines apply to developers that
6+
are new to open source, as well as to experienced open source developers.
77

88
Change Requirements
99
-------------------
1010

1111
This section contains guidelines for submitting code changes for review.
1212
For more information on how to submit a change using Gerrit, please see
13-
:doc:`Gerrit <gerrit>`.
13+
:doc:`Working with Gerrit <gerrit>`.
1414

15-
Changes are submitted as Git commits. Each commit must contain:
15+
All changes to Hyperledger Fabric are submitted as Git commits via Gerrit.
16+
Each commit must contain:
1617

17-
- a short and descriptive subject line that is 72 characters or fewer,
18-
followed by a blank line.
19-
- a change description with your logic or reasoning for the changes,
20-
followed by a blank line
21-
- a Signed-off-by line, followed by a colon (Signed-off-by:)
18+
- a short and descriptive subject line that is 55 characters or fewer,
19+
followed by a blank line,
20+
- a change description with the logic or reasoning for your changes,
21+
followed by a blank line,
22+
- a Signed-off-by line, followed by a colon (Signed-off-by:), and
2223
- a Change-Id identifier line, followed by a colon (Change-Id:). Gerrit
2324
won't accept patches without this identifier.
2425

2526
A commit with the above details is considered well-formed.
2627

28+
.. note:: You don't need to supply the Change-Id identifier for a new
29+
commit; this is added automatically by the ``commit-msg``
30+
Git hook associated with the repository.
31+
If you subsequently amend your commit and resubmit it,
32+
using the same Change-Id value as the initial commit will
33+
guarantee that Gerrit will recognize that subsequent commit
34+
as an amended commit with respect to the earlier one.
35+
2736
All changes and topics sent to Gerrit must be well-formed.
28-
Informationally, ``commit messages`` must include:
37+
In addition to the above mandatory content in a commit, a commit message
38+
should include:
2939

3040
- **what** the change does,
3141
- **why** you chose that approach, and
32-
- **how** you know it works -- for example, which tests you ran.
42+
- **how** you know it works --- for example, which tests you ran.
3343

3444
Commits must :doc:`build cleanly <../dev-setup/build>` when applied on
3545
top of each other, thus avoiding breaking bisectability. Each commit
36-
must address a single identifiable issue and must be logically
37-
self-contained.
46+
should address a single identifiable JIRA issue and should be logically
47+
self-contained. For example, one commit might fix whitespace issues,
48+
another commit might rename a function, while a third commit could
49+
change some code's functionality.
3850

39-
For example: One commit fixes whitespace issues, another renames a
40-
function and a third one changes the code's functionality. An example
41-
commit file is illustrated below in detail:
51+
A well-formed commit is illustrated below in detail:
4252

4353
::
4454

45-
[FAB-XXXX] A short description of your change with no period at the end
55+
[FAB-XXXX] purpose of commit, no more than 55 characters
4656

47-
You can add more details here in several paragraphs, but please keep each line
48-
width less than 80 characters. A bug fix should include the issue number.
57+
You can add more details here in several paragraphs, but please keep
58+
each line less than 80 characters long.
4959

5060
Change-Id: IF7b6ac513b2eca5f2bab9728ebd8b7e504d3cebe1
5161
Signed-off-by: Your Name <commit-sender@email.address>
5262

53-
Include the issue ID in the one line description of your commit message for
54-
readability. Gerrit will link issue IDs automatically to the corresponding
55-
entry in Jira.
56-
57-
Each commit must also contain the following line at the bottom of the commit
58-
message:
59-
60-
::
61-
62-
Signed-off-by: Your Name <your@email.address>
63-
64-
The name in the Signed-off-by line and your email must match the change
65-
authorship information. Make sure your :file:``.git/config`` is set up
66-
correctly. Always submit the full set of changes via Gerrit.
63+
The name in the ``Signed-off-by:`` line and your email must match the change
64+
authorship information. Make sure your personal ``.gitconfig`` file is set up
65+
correctly.
6766

6867
When a change is included in the set to enable other changes, but it
6968
will not be part of the final set, please let the reviewers know this.
@@ -89,10 +88,10 @@ Upon completion, "Hyperledger Jobbuilder" will add to the CR a *+1
8988
vote* if successful and a *-1 vote* otherwise.
9089

9190
In case of failure, explore the logs linked from the CR History. If
92-
you spot a problem with your CR amend your commit and push it to
93-
update it. The CI process will kick off again.
91+
you spot a problem with your CR, amend your commit and push it to
92+
update it, which will automatically kick off the CI process again.
9493

95-
If you see nothing wrong with your CR it might be that the CI process
94+
If you see nothing wrong with your CR, it might be that the CI process
9695
simply failed for some reason unrelated to your change. In that case
9796
you may want to restart the CI process by posting a reply to your CR
9897
with the simple content "reverify". Check the `CI management page

0 commit comments

Comments
 (0)