github.com/adnan-c/fabric_e2e_couchdb@v0.6.1-preview.0.20170228180935-21ce6b23cf91/docs/Gerrit/changes.md (about)

     1  # Submitting a Change to Gerrit
     2  
     3  Carefully review the following before submitting a change. These
     4  guidelines apply to developers that are new to open source, as well as
     5  to experienced open source developers.
     6  
     7  ## Change Requirements
     8  
     9  This section contains guidelines for submitting code changes for review.
    10  For more information on how to submit a change using Gerrit, please
    11  see [Gerrit](gerrit.md).
    12  
    13  Changes are submitted as Git commits. Each commit must contain:
    14  
    15  - a short and descriptive subject line that is 72 characters or fewer,
    16    followed by a blank line.
    17  - a change description with your logic or reasoning for the changes,
    18    followed by a blank line
    19  - a Signed-off-by line, followed by a colon (Signed-off-by:)
    20  - a Change-Id identifier line, followed by a colon (Change-Id:). Gerrit won't
    21    accept patches without this identifier.
    22  
    23  A commit with the above details is considered well-formed.
    24  
    25  All changes and topics sent to Gerrit must be well-formed. Informationally,
    26  `commit messages` must include:
    27  
    28  * **what** the change does,
    29  * **why** you chose that approach, and
    30  * **how** you know it works -- for example, which tests you ran.
    31  
    32  Commits must [build cleanly](../dev-setup/build.md) when applied in top of each
    33  other, thus avoiding breaking bisectability. Each commit must address a single
    34  identifiable issue and must be logically self-contained.
    35  
    36  For example: One commit fixes whitespace issues, another renames a
    37  function and a third one changes the code's functionality.  An example commit
    38  file is illustrated below in detail:
    39  
    40  ```
    41  A short description of your change with no period at the end
    42  
    43  You can add more details here in several paragraphs, but please keep each line
    44  width less than 80 characters. A bug fix should include the issue number.
    45  
    46  Fix Issue # 7050.
    47  
    48  Change-Id: IF7b6ac513b2eca5f2bab9728ebd8b7e504d3cebe1
    49  Signed-off-by: Your Name <commit-sender@email.address>
    50  ```
    51  Each commit must contain the following line at the bottom of the commit
    52  message:
    53  
    54  ```
    55  Signed-off-by: Your Name <your@email.address>
    56  ```
    57  
    58  The name in the Signed-off-by line and your email must match the change
    59  authorship information. Make sure your :file:`.git/config` is set up
    60  correctly. Always submit the full set of changes via Gerrit.
    61  
    62  When a change is included in the set to enable other changes, but it
    63  will not be part of the final set, please let the reviewers know this.