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

PyGMT authorship policy for Changelog, Zenodo and Publications #691

Closed weiji14 closed 3 years ago

weiji14 commented 3 years ago

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 https://github.com/GenericMappingTools/pygmt/issues/677#issue-732055450:

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 https://github.com/GenericMappingTools/pygmt/pull/683#discussion_r519031191_


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 https://github.com/fatiando/contributing/pull/13. The TLDR of it I think is:


And just to link to a few useful references from https://github.com/GenericMappingTools/pygmt/issues/677#issuecomment-721410615_:

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

seisman commented 3 years ago

The policy sounds good to me.

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

leouieda commented 3 years ago

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 commented 3 years ago

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