JanCBrammer/biopeaks

potentially add .mailmap for consistent commiter identities

sappelhoff opened this issue · 1 comments

sappelhoff commented

Hi @JanCBrammer, I am one of the reviewers of your submission at JOSS openjournals/joss-reviews#2621 and over the next weeks I'll dive into the repo and ... review it :-)

I'll try to make small and targeted issues whenever I can, this is the first one:

When trying to find which people contributed to this code, I ran git shortlog --summary --email and got the following output:

     7  Jan C. Brammer <j.brammer@psych.ru.nl>
     1  Jan C. Brammer <jan.c.brammer@gmail.com>
   242  JohnDoenut <j.brammer@psych.ru.nl>
   137  JohnDoenut <jan.c.brammer@gmail.com>

I can see that it's all you, but you might want to consider adding a .mailmap file:

it is used to map author and committer names and email addresses to canonical real names and email addresses

so that you can merge your 4 identities into one reasonable identity (of your choice).

For example, see this .mailmap --> https://github.com/mne-tools/mne-bids/blob/master/.mailmap

Edit: To clarify the goal: if there is only one author, then running git shortlog --summary --email should also only yield one output (not 4 as in this case) ... and that goal can be achieved by .mailmap

JanCBrammer commented

Hi @sappelhoff, thanks for reviewing the repositoy and thanks for the useful pointer!

if there is only one author, then running git shortlog --summary --email should also only yield one output

Works like a charm.

390  Jan C. Brammer <jan.c.brammer@gmail.com>
  • 👍2