github.com/derekparker/go-pear@v1.3.2/README.md (about)

     1  ## Welcome to Pear
     2  
     3  Pear is command line utility used while pairing to ensure that each programmer is reflected in the git commits. Pear is inspired by [Hitch](https://github.com/therubymug/hitch).
     4  
     5  ## Installing Pear
     6  
     7  On OSX:
     8  
     9  	$ brew tap hashrocket/formulas && brew install pear
    10  
    11  For Linux we intend to be distributed via apt-get, until then, either download the latest release from github, or if you have the Go toolchain available use:
    12  
    13  	$ make prepare
    14  	$ make build
    15  
    16  to compile the binary.
    17  
    18  ## Using Pear
    19  ### Changing Pairs
    20  
    21  	$ pear chriserin derekparker
    22  
    23  When prompted, enter the developer's full name. This changes the local git configuration (configuration per git repository).
    24  
    25  ### Checking Pairs
    26  
    27  	$ pear
    28  
    29  Pear with no arguments will let you know what programmers are configured with git.
    30  
    31  ### So you just want to work alone
    32  
    33  	$ pear chriserin
    34  
    35  Will change the git configuration to use just your id.
    36  
    37  ### To remove local pear configuration
    38  
    39  	$ pear -u
    40  
    41  This will unset local user configuration and fall back to the global configuration.
    42  
    43  ### So you like giving credit
    44  
    45  	$ pear chriserin derekparker briandunn jackchristenson jonallured andrewdennis joshdavey
    46  
    47  Will let you setup your git configuration to reflect all the programmers that have contributed to a commit.
    48  
    49  ### Changing Group/Email
    50  
    51  	$ pear --email dev@hashrocket.com
    52  
    53  OR
    54  
    55  	$ pear chriserin derekparker --email dev@hashrocket.com
    56  
    57  Will configure the email associated with commits, the programmers involved will be listed as plus delimited metadata in the email address, like:
    58  
    59  	dev+chriserin+derekparker@hashrocket.com
    60  
    61  ### Changing Pairs globally
    62  
    63  	$ pear --global chriserin derekparker
    64  
    65  Will configure git globally so that the contributing programmers will be credited in commits across all projects and repositories.
    66  
    67  ## How Pear works
    68  
    69  Pear works by changing your local git configuration, the configuration for a specific repository. Pear stores the full name of each developer in the ~/.pearrc so that a programmer will only be prompted once for his/her full name.
    70  
    71  If your workflow or your organization's workflow requires that the git author and git committer for commits should differ, you can change the following environment variables:
    72  
    73  	GIT_COMMITTER_NAME
    74  
    75  and
    76  
    77  	GIT_COMMITTER_EMAIL
    78  
    79  These environment variables override the details provided by the git configuration. At Hashrocket, we use "Hashrocket Workstation" as the `GIT_COMMITTER_NAME` to provide a little bit more detail about where the commit is coming from.