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 .mailmap to improve git shortlog -sn output #378

Merged
merged 1 commit into from
Jan 19, 2021

Conversation

yarikoptic
Copy link
Contributor

@yarikoptic yarikoptic commented Jan 14, 2021

.mailmap is mechanism to properly account for contributors using different git configuration "ids".

output on master master
$> git shortlog -sn | nl
     1	   446	Stefano Moia
     2	   415	vinferrer
     3	   231	Vicente Ferrer
     4	   215	smoia
     5	   112	François Lespinasse
     6	   101	Eneko
     7	    74	Eneko Uruñuela
     8	    74	eurunuela
     9	    54	Ross Markello
    10	    49	Rachael Stickland
    11	    44	allcontributors[bot]
    12	    19	Apoorva Ayyagari
    13	     6	Taylor Salo
    14	     4	Daniel Alcalá
    15	     4	Merel van der Thiel
    16	     4	Vittorio Iacovella
    17	     3	RayStick
    18	     3	kristinazvolanek
    19	     2	BrightMG
    20	     2	Inés Chavarría
    21	     2	Molly Bright
    22	     1	Daniel Alcalá López
    23	     1	Katie Bottenhorn
    24	     1	Kristina Zvolanek
    25	     1	Victor
    26	     1	vferrer
output on this PR
$> git shortlog -sn | nl                                                    
     1	   661	Stefano Moia
     2	   647	Vicente Ferrer
     3	   249	Eneko Uruñuela
     4	   112	François Lespinasse
     5	    54	Ross Markello
     6	    49	Rachael Stickland
     7	    44	allcontributors[bot]
     8	    19	Apoorva Ayyagari
     9	     6	Taylor Salo
    10	     4	Daniel Alcalá
    11	     4	Kristina Zvolanek
    12	     4	Merel van der Thiel
    13	     4	Vittorio Iacovella
    14	     3	RayStick
    15	     2	BrightMG
    16	     2	Inés Chavarría
    17	     2	Molly Bright
    18	     1	Daniel Alcalá López
    19	     1	Katie Bottenhorn
    20	     1	Victor
    21	     1	Yaroslav Halchenko

Change Type

  • bugfix (+0.0.1)
  • minor (+0.1.0)
  • major (+1.0.0)
  • refactoring (no version update)
  • test (no version update)
  • infrastructure (no version update)
  • documentation (no version update)
  • other

Checklist before review

  • I added everything I wanted to add to this PR.
  • [Code or tests only] I wrote/updated the necessary docstrings.
  • [Code or tests only] I ran and passed tests locally.
  • [Documentation only] I built the docs locally.
  • My contribution is harmonious with the rest of the code: I'm not introducing repetitions.
  • My code respects the adopted style, especially linting conventions.
  • The title of this PR is explanatory on its own, enough to be understood as part of a changelog.
  • I added or indicated the right labels.
  • I added information regarding the timeline of completion for this PR.
  • Please, comment on my PR while it's a draft and give me feedback on the development!

@codecov
Copy link

codecov bot commented Jan 14, 2021

Codecov Report

Merging #378 (4d5c347) into master (f587559) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #378   +/-   ##
=======================================
  Coverage   94.61%   94.61%           
=======================================
  Files           8        8           
  Lines         836      836           
=======================================
  Hits          791      791           
  Misses         45       45           

@smoia smoia changed the title ENH: add .mailmap to provide better "git shortlog -sn" Aadd .mailmap to improve "git shortlog -sn" output Jan 19, 2021
@smoia smoia changed the title Aadd .mailmap to improve "git shortlog -sn" output Add .mailmap to improve "git shortlog -sn" output Jan 19, 2021
@smoia smoia added the Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog label Jan 19, 2021
@smoia smoia self-assigned this Jan 19, 2021
@smoia
Copy link
Member

smoia commented Jan 19, 2021

Hello @yarikoptic ! Thank you for the proposal!

I don't think there's a major issue in adding .mailmap. Do you have any specific use in mind though?

Copy link
Member

@smoia smoia left a comment

Choose a reason for hiding this comment

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

Looks completely fine to me, could I ask you to add @danalclop to this list before merging? I noticed that in the shortlog of this PR he appears both as Daniel Alcala' and as Daniel Alcala' Lopez

@smoia smoia changed the title Add .mailmap to improve "git shortlog -sn" output Add .mailmap to improve git shortlog -sn output Jan 19, 2021
@yarikoptic
Copy link
Contributor Author

I don't think there's a major issue in adding .mailmap. Do you have any specific use in mind though?

git shortlog -sn is my immediate use case

@yarikoptic
Copy link
Contributor Author

both as Daniel Alcala' and as Daniel Alcala' Lopez

added, force-pushed

Copy link
Member

@smoia smoia left a comment

Choose a reason for hiding this comment

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

LGTM!

And I think I can merge it in without waiting for a second review

@smoia smoia merged commit ac0096b into physiopy:master Jan 19, 2021
@smoia
Copy link
Member

smoia commented Jan 21, 2021

🚀 PR was released in 2.3.3 🚀

@smoia smoia added the released This issue/pull request has been released. label Jan 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Internal Changes affect the internal API. It doesn't increase the version, but produces a changelog released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants