Skip to content

Names and gravatars for authors and contributors can be improved #1270

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

Closed
karenetheridge opened this issue Aug 8, 2014 · 6 comments · Fixed by #1281
Closed

Names and gravatars for authors and contributors can be improved #1270

karenetheridge opened this issue Aug 8, 2014 · 6 comments · Fixed by #1281

Comments

@karenetheridge
Copy link
Contributor

Background:

These two sets of names aren't the full list of people that should be credited with the distribution. For example, let's take a look at: https://metacpan.org/release/ETHER/Dist-Zilla-Plugin-MakeMaker-Awesome-0.22#authors

I (ether) did the last upload, but I'm not one of the distribution authors (that's AVAR, as seen at https://metacpan.org/source/ETHER/Dist-Zilla-Plugin-MakeMaker-Awesome-0.22/META.json#L3). Avar gets no credit in the right sidebar at all, and ether gets listed twice, as the releaser and one of the contributors!

This happens because the contributor list (which is added to metadata and pod) is being tailored for the pod: there is an authors section (which lists Avar) and then there is a Contributors section (which lists everyone else, including ether). When the list of contributor names are extracted from git history, the authors are removed, because they get their own pod section.

What I would propose is this change on metacpan, for deciding what contributors to list at #authors:

  • start with x_contributors metadata
  • add in all the authors (from the authors metadata field)
  • remove the releaser (name and email address taken from the metacpan profile).

This should come out looking a bit nicer.

@kentfredric
Copy link
Contributor

the only thing I see presently missing from this plan is "past releasers". Which may or may not be important, but there's presently no obvious way to display that in the metadata if it is desirable.

@rjbs
Copy link
Contributor

rjbs commented Aug 8, 2014

@kentfredric The creators of the contributors data should try to take that into account.

I think this sounds totally reasonable.

@rwstauner
Copy link
Contributor

See also #940.
I also found this mock up link on the wiki though i don't know where it came from: http://buzzword.org.uk/2014/credits-stuff/MooseX-Types.html

karenetheridge added a commit to karenetheridge/Dist-Zilla-Plugin-Git-Contributors that referenced this issue Aug 8, 2014
          - when on MSWin32, check for mysysgit version and also set
            appropriate config options for proper unicode support
          - new "order_by" configuration option, to allow sorting contributors
            by number of commits made, rather than alphabetically
          - mark "include_releaser" option as experimental, as it will likely
            get removed if metacpan/metacpan-web#1270 gets resolved
@oalders
Copy link
Member

oalders commented Aug 8, 2014

Looks like that site belongs to @tobyink ?

@dagolden
Copy link

dagolden commented Aug 8, 2014

I don't know that it needs to be so complicated. I don't know that most people understand, know about, or care about the distinction between managers, authors and contributors. It could just say "Karen Etheridge and 4 others".

Karen's algorithm seems decent enough for the use this gets.

@haarg
Copy link
Member

haarg commented Aug 8, 2014

@wchristian has previously requested that release managers be listed in some form, but I think that can be considered separately from this.

I like what Karen has proposed.

karenetheridge added a commit to karenetheridge/Dist-Zilla-PluginBundle-Author-ETHER that referenced this issue Aug 16, 2014
          - revert git contributor change from v0.069; opened
            (github) metacpan/metacpan-web#1270 instead.
          - order contributors by number of commits, descending
          - no longer adding an $AUTHORITY variable to modules, as nothing
            (save Class::MOP, Moose and Moo) has ever used it - this also
            avoids shifting our line numbers by 3
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 a pull request may close this issue.

6 participants