Git.mailmap file: Associating contributor and email aliases

Download Git for free

Syntax

  • # Only replace email addresses
    <primary@example.org> <alias@example.org>
  • # Replace name by email address
    Contributor <primary@example.org>
  • # Merge multiple aliases under one name and email
    # Note this will not associate 'Other <alias2@example.org>'.
    Contributor <primary@example.org> <alias1@example.org> Contributor <alias2@example.org>

Remarks

A .mailmap file may be created in any text editor and is just a plain text file containing optional contributor names, primary email addresses, and their aliases. it has to be placed in the project's root, next to the .git directory.

Keep in mind that this just modifies the visual output of commands like git shortlog or git log --use-mailmap. This will not rewrite commit history or prevent commits with varying names and/or email addresses.

To prevent commits based on information such as email addresses, you should use git hooks instead.

Related Examples

Merge contributers by aliases to show commit count in shortlog.