github.com/kchristidis/fabric@v1.0.4-0.20171028114726-837acd08cde1/docs/source/Gerrit/changes.rst (about)

     1  Submitting a Change to Gerrit
     2  =============================
     3  
     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.
     7  
     8  Change Requirements
     9  -------------------
    10  
    11  This section contains guidelines for submitting code changes for review.
    12  For more information on how to submit a change using Gerrit, please see
    13  :doc:`Gerrit <gerrit>`.
    14  
    15  Changes are submitted as Git commits. Each commit must contain:
    16  
    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:)
    22  -  a Change-Id identifier line, followed by a colon (Change-Id:). Gerrit
    23     won't accept patches without this identifier.
    24  
    25  A commit with the above details is considered well-formed.
    26  
    27  All changes and topics sent to Gerrit must be well-formed.
    28  Informationally, ``commit messages`` must include:
    29  
    30  -  **what** the change does,
    31  -  **why** you chose that approach, and
    32  -  **how** you know it works -- for example, which tests you ran.
    33  
    34  Commits must :doc:`build cleanly <../dev-setup/build>` when applied in
    35  top of each other, thus avoiding breaking bisectability. Each commit
    36  must address a single identifiable issue and must be logically
    37  self-contained.
    38  
    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:
    42  
    43  ::
    44  
    45      [FAB-XXXX] A short description of your change with no period at the end
    46  
    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.
    49  
    50      Change-Id: IF7b6ac513b2eca5f2bab9728ebd8b7e504d3cebe1
    51      Signed-off-by: Your Name <commit-sender@email.address>
    52  
    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.
    67  
    68  When a change is included in the set to enable other changes, but it
    69  will not be part of the final set, please let the reviewers know this.
    70  
    71  .. Licensed under Creative Commons Attribution 4.0 International License
    72     https://creativecommons.org/licenses/by/4.0/
    73