augustohp / git-pair Goto Github PK

When adding a pair with git pair <author name>, sort names alphabetically so throughout history the same pair has always the same name.

We should prevent people from adding the same author as a pair or two pair authors with the same name:

Expected behaviour is as follows:

$ git pair Nelson
Local authors name now are: Augusto Pascutti + Nelson
$ git pair Nelson
You are already pairing with "Nelson"
$ git pair reset
Local author name now is: Augusto Pascutti
$ git pair "Augusto Pascutti"
You cannot pair with yourself, can you?

Given we are pairing on a git repository with a history, we can use all author names available on the history (and the ones already provided in the pairing standard) to identify which authors we want to pair with.

Given current authors in the repository are: Augusto Pascutti, Ivo Nascimento, Anderson Pereira and Antonio Pinto:

$ git pair in
Local authors name now are: Augusto Pascutti + Ivo Nascimento

$ git pair ap
There are two authors which match "ap" initials:
    ape) Anderson Pereira
    api) Antonio Pinto

Re-issue the command with an unique initial.

Note that although ap also matches Augusto Pascutti we should identify and eliminate him as a possible pair given he is the committer of the session and therefore a constant on the pairing session.

Provide some help through:

• Display short help if no arguments are given.
• Short format through -h option.
• Man page.
• Long format though --help (same as man git-pair).

What to put in the man page

• Every command format available.
• Why we don't change the email.
• From where we retrieve the user name.
• How to change the name of the command to avoid conflict with similar tools (some are bundled with other stuff).
• How to update to newer versions.
• Exit codes.

It would be nice to signal a pair as a different author through changing his e-mail, since that is used by GitHub to display avatars and identify authors.

We should definitely use subaddress extension of e-mails in order to do that but this poses the following problems:

1. When sorting author names (issue #3), we can't sort e-mails or we will end up with an invalid e-mail account, making the same pair to have different e-mails (depending on whose machine the pair was made).
2. Not all e-mail providers accept subaddress extension and when they accept they may not use the same separator.
3. Using initials instead of author names (issue #5) could return two different e-mail addresses for the same author.

Although none of these issues are blockers, they are problems which should be exposed and dealed in the most acceptable fashion without a configuration file being needed.

"Instalation" should be "Installation"