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

PyGMT authorship policy for Changelog, Zenodo and Publications #691

Closed
weiji14 opened this issue Nov 14, 2020 · 3 comments · Fixed by #726
Closed

PyGMT authorship policy for Changelog, Zenodo and Publications #691

weiji14 opened this issue Nov 14, 2020 · 3 comments · Fixed by #726
Labels
question Further information is requested

Comments

@weiji14
Copy link
Member

weiji14 commented Nov 14, 2020

Description of the desired feature

The PyGMT project started by @leouieda in 2017 is gaining quite some traction, and it's time to come up with a good system to assign authorship as we work towards more releases and perhaps a paper (#677) in the future!

Originally raised by @leouieda at #677 (comment):

It's really important that we agree on this before doing any work a paper. See the Fatiando policy which was generated after long discussion and research into similar policies.

Also mentioned at #683 (comment)_


To begin, I think https://github.com/fatiando/contributing/blob/master/AUTHORSHIP.md is a nice starting template to use, and so is the original discussion at fatiando/community#13. The TLDR of it I think is:

  • Changelog: If you made a commit as a contributor, we'll mention your Github @ handle (at the very minimum) or your full name in our changelog for a particular version
  • Zenodo: Your full name must be in AUTHORS.md, (+ Affiliation and ORCID). See also https://doi.org/10.5281/zenodo.3781524.
  • Paper: Have made a 'significant' contribution to the PyGMT project (which can be more than just coding) and you are involved in the writing of the manuscript.

And just to link to a few useful references from #677 (comment)_:

Are you willing to help implement and maintain this feature? Yes

@weiji14 weiji14 added the question Further information is requested label Nov 14, 2020
@seisman
Copy link
Member

seisman commented Nov 17, 2020

The policy sounds good to me.

Let's hear more voices from @GenericMappingTools/python @GenericMappingTools/python-contributors

@leouieda
Copy link
Member

Just to add a little bit of background, the reason for that policy was to create a clear document we can point to as both an incentive for new contributors and to avoid toxic discussions that can arise about authorship. Our goal was to be as inclusive as possible and very generous with respect to credit. The policy does that with a 3 tier system: changelog, Zenodo, paper. Each has more "prestige" than the previous and so we can also expect more effort from people. To get into the changelog, you only need to make a PR. To go into Zenodo, you need to edit the Authors file as well. To get into the paper, you need to read/revise the paper and add yourself as author on top of the previous requirements.

@seisman seisman mentioned this issue Dec 11, 2020
5 tasks
@seisman
Copy link
Member

seisman commented Dec 11, 2020

I just opened a PR (#726) to push it forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants