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

Short affiliation names in AUTHORS.md #897

Closed
seisman opened this issue Feb 15, 2021 · 9 comments · Fixed by #957
Closed

Short affiliation names in AUTHORS.md #897

seisman opened this issue Feb 15, 2021 · 9 comments · Fixed by #957
Labels
good first issue Good for newcomers maintenance Boring but important stuff for the core devs
Milestone

Comments

@seisman
Copy link
Member

seisman commented Feb 15, 2021

Initial discussed in #857 (review):

  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.

@seisman seisman added the question Further information is requested label Feb 15, 2021
@liamtoney
Copy link
Member

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

@seisman
Copy link
Member Author

seisman commented Feb 16, 2021

@weiji14
Copy link
Member

weiji14 commented Feb 16, 2021

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

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

image

@michaelgrund
Copy link
Member

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

@seisman
Copy link
Member Author

seisman commented Feb 17, 2021

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.

@seisman seisman added this to the 0.3.1 milestone Feb 17, 2021
@seisman seisman added good first issue Good for newcomers maintenance Boring but important stuff for the core devs and removed question Further information is requested labels Feb 17, 2021
@core-man
Copy link
Member

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
Copy link
Member Author

seisman commented Feb 22, 2021

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
Copy link
Member

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
Copy link
Member

weiji14 commented Feb 22, 2021

Cool, let's go with Solution 1 in #897 (comment) then, i.e.:

  • Name | 0000-0001-2345-6789 | University/Company/Unaffiliatied

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants