search

GenericMappingTools / pygmt

A Python interface for the Generic Mapping Tools.
https://www.pygmt.org
BSD 3-Clause "New" or "Revised" License
747 stars 216 forks source link

Short affiliation names in AUTHORS.md #897

Closed seisman closed 3 years ago

seisman commented 3 years ago

Initial discussed in https://github.com/GenericMappingTools/pygmt/pull/857#pullrequestreview-588235476:

  1. Do we want the affiliation to be the full Department, University, City, Country format? I understand that the full affiliation would be needed for a paper, but again, a lot can happen between now and the paper coming out. Right now it's only the University name listed on Zenodo (hover over the names at https://zenodo.org/record/4253459).

Is the motivation to update this less often? We could forgo affiliations here and just ask for them when making releases or just when writing papers?

Yeah, would be best to keep changes to a minimum. Do people update their ORCID page often? I suppose we could just use what's on their ORCID page, even if it might be a pain during releases to check through every single person's current location.

The full affiliation names sometimes are longer than one line in GitHub web UI, and more than 200 characters in the plaintext markdown file (see the screenshot below).

image

And the full affiliation names won't be used unless when we write the first paper. So I prefer to have shorter affiliation names.

liamtoney commented 3 years ago

I'm fine with short affiliations. Looking at the line wraps above, I appear to be the worst offender 😉 .

seisman commented 3 years ago

Ping @leouieda @mjziebarth @michaelgrund @tjnewton @willschlitzer @weiji14

weiji14 commented 3 years ago

Alternatively, if people want to keep their full affiliation, we can use a table, by adding:

| Name | ORCID | Affiliation
|:--|:--:|:--|

image

michaelgrund commented 3 years ago

I'm fine with short affiliations, too. However, since mine is currently the shortest I'd leave it to the others to decide.

seisman commented 3 years ago

It seems more than half (5/9) of the "PyGMT Developers" agree with short affiliation names.

Alternatively, if people want to keep their full affiliation, we can use a table, by adding:

The table looks good, but making the plain markdown file more complicated.

core-man commented 3 years ago

Could I help with this issue? It seems that it is a good first issue for me.

Based on the above discussion, could we just keep the authors' full names, ORCID, and university/institute. The maximum length is about 73 under preview (i.e., Meghan Jones), which corresponds to 146 characters.

The second solution is to replace the authors' homepage with ORCID at the same time. Usually, we can find the authors' homepage on their ORCID websites. The maximum length is only 48 under preview and 91 in plaintext.

seisman commented 3 years ago

The second solution is to replace the authors' homepage with ORCID at the same time. Usually, we can find the authors' homepage on their ORCID websites.

That's not always true. I'm in favor of the first solution.

michaelgrund commented 3 years ago

The second solution is to replace the authors' homepage with ORCID at the same time. Usually, we can find the authors' homepage on their ORCID websites.

That's not always true. I'm in favor of the first solution.

Me too, as pointed out not everybody has listed a homepage on the ORCID portal and some people don't even have a "real" homepage (execpt the linked GitHub profile).

weiji14 commented 3 years ago

Cool, let's go with Solution 1 in https://github.com/GenericMappingTools/pygmt/issues/897#issuecomment-783413696 then, i.e.:

@core-man, feel free to open up a Pull Request for this, have a look at CONTRIBUTING.md to get started and don't hesitate to ask us if you need any help!