search

fatiando / community

Community resources, guidelines, meeting notes, authorship policy, maintenance, etc.
Other
8 stars 4 forks source link

Add authorship policy for paper and software archives #13

Closed santisoler closed 4 years ago

santisoler commented 4 years ago

Add AUTHORSHIP.md file containing authorship policies for any library belonging to Fatiando a Terra.

This document lays out the general rules for giving credit to contributors. Our main goal is to be clear about this upfront and provide an incentive for academics looking to get involved in the project.

leouieda commented 4 years ago

Hi @santisoler thanks for starting this! I'll have a look as soon as possible.

leouieda commented 4 years ago

@santisoler I updated the text based on our discussion last week. What do you think?

leouieda commented 4 years ago

That's a good point. What I meant was that the order will be defined like that, but everyone who ever contributed will be invited as author. What would you think of that?

leouieda commented 4 years ago

@fatiando/contributors @fatiando/pooch I'd be interested to know your thoughts on this. We're drafting a document outlining the criteria for authorship in archives and publications and how we go about giving credit to contributors. This document will be become a part of every repo we have so it would be great to get everyone's opinion.

leouieda commented 4 years ago

I talked this over with @santisoler and we made a few small changes to the author order:

  1. The order on Zenodo would be the git shortlog of the entire history. This makes it a lot easier to make Zenodo archives since we release with a relatively high frequency.
  2. The order on papers will be defined by the git shortlog since the last release that an associate paper.

Note that all of these are subject to change based on common sense and consensus.

leouieda commented 4 years ago

Thanks for the fixes @hugovk!

leouieda commented 4 years ago

Alright, I have added links to the authorship file in the maintenance and contributing guides. I also created the fatiando/.github repo and added our current templates to it. fatiando/.github#2 will add "include yourself in AUTHORS.md" to the PR checklist and modify the welcome message from the bot as well (I'd appreciate some reviews on that).

This seems good to go so I'll hit the merge button! :tada: Thank you for the input everyone!