Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add top-level Git mailmap to normalize commit author variants #366

Merged
merged 3 commits into from
Aug 17, 2023

Conversation

sbesson
Copy link
Member

@sbesson sbesson commented Jun 22, 2023

This PR adds a top-level mapping file allowing to normalize commits from the same contributor and associate all commits to a canonical "First Name Last Name " author line.

The following rules are used for the construction of the .mailmap file:

  • for all contributors who are employees of the University or Dundee, Glencoe Software, the @dundee.ac.uk, or @glencoesoftware.com email address is used as the canonical email address
  • for all contributors with an executed CLA, the real name and email address sent via the CLA is used as the canonical address
  • for all contributors, the name used in https://www.openmicroscopy.org/teams/ or https://www.openmicroscopy.org/contributors/ is used as the canonical real name.

The .mailmap is constructed according to the official documentation using one of the two forms:

for mapping different email addresses and

Proper Name <[email protected]> Commit Name <[email protected]>

for mapping different real names.

The unique list of commit authors can be generated and reviewing using git shortlog -se

See also ome/openmicroscopy#6349, ome/bioformats#4026, ome/omero-web#482, ome/omero-py#375 and ome/omero-scripts#208

This mapping file aims to associate all commits from the same contributor
to a single "First Name Last Name <email>" author line. The
University of Dundee or the Glencoe Software email address are used
as the canonical address for current employees of these institutions.
For contributors with an executed CLA, the email address specified
in the  CLA is used as the canonical one.
.mailmap Show resolved Hide resolved
.mailmap Outdated Show resolved Hide resolved
.mailmap Outdated Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this email address was used with different author names so I would need to add one more line if we want to use the most verbose variant. Let me know if that is your preference

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could make things more complicated. Let's keep it as it is

.mailmap Outdated Show resolved Hide resolved
@sbesson sbesson requested a review from jburel August 14, 2023 11:08
@jburel jburel merged commit 33695c4 into ome:master Aug 17, 2023
8 checks passed
jburel added a commit to jburel/omero-insight that referenced this pull request Aug 17, 2023
@sbesson sbesson deleted the mailmap branch August 21, 2023 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants