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

Add authorship policy #726

Merged
merged 6 commits into from
Feb 10, 2021
Merged

Add authorship policy #726

merged 6 commits into from
Feb 10, 2021

Conversation

seisman
Copy link
Member

@seisman seisman commented Dec 11, 2020

Description of proposed changes

The aurthorship policy is copied from https://github.com/fatiando/contributing/blob/master/AUTHORSHIP.md, with tiny changes.

Fixes #691

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Notes

  • You can write /format in the first line of a comment to lint the code automatically

@willschlitzer
Copy link
Contributor

"We aim to write academic papers for most of your software packages" Shouldn't that be "most of our software packages" instead?

AUTHORSHIP.md Outdated Show resolved Hide resolved
AUTHORSHIP.md Outdated Show resolved Hide resolved
@seisman seisman added the maintenance Boring but important stuff for the core devs label Dec 11, 2020
@seisman seisman added this to the 0.3.0 milestone Dec 11, 2020
@seisman seisman requested review from a team December 11, 2020 14:55
@seisman seisman marked this pull request as ready for review February 6, 2021 02:03
@seisman seisman marked this pull request as draft February 6, 2021 02:03
@weiji14 weiji14 mentioned this pull request Feb 9, 2021
19 tasks
@willschlitzer
Copy link
Contributor

@GenericMappingTools/python In preparation for the v0.3 release, is the plan to have @leouieda as first author and @PaulWessel as last author, and then all of the contributors listed on AUTHORS.md in the order of numbers of commits? That makes the most sense to me, but I also don't feel strongly about a particular order.

@michaelgrund
Copy link
Member

@GenericMappingTools/python In preparation for the v0.3 release, is the plan to have @leouieda as first author and @PaulWessel as last author, and then all of the contributors listed on AUTHORS.md in the order of numbers of commits? That makes the most sense to me, but I also don't feel strongly about a particular order.

I think that's the best way to handle the order @willschlitzer since in most scientific papers the order represents some kind of "workload" 😅.

Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with the changes.

@weiji14
Copy link
Member

weiji14 commented Feb 9, 2021

and then all of the contributors listed on AUTHORS.md in the order of numbers of commits? That makes the most sense to me, but I also don't feel strongly about a particular order.

Number of commits isn't perfect, but as long as we communicate about this in good faith, I think we'll be ok. Specifically would like to mention Liam's work on the ROSES and upcoming Scipy2021 stuff which is super valuable but not tracked on git. So this metric should serve as a rough guideline and not be set in stone.

liamtoney added a commit that referenced this pull request Feb 9, 2021
@seisman seisman marked this pull request as ready for review February 10, 2021 14:30
@seisman seisman merged commit aeae956 into master Feb 10, 2021
@seisman seisman deleted the authorship branch February 10, 2021 15:05
@weiji14 weiji14 mentioned this pull request Nov 3, 2021
12 tasks
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
* Get a copy of the authorship policy from https://github.com/fatiando/contributing
* Change the project name to PyGMT
* Update AUTHORSHIP.md
* Update contribution explanations

Co-authored-by: Wei Ji <[email protected]>
Co-authored-by: Will Schlitzer <[email protected]>
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 help wanted Helping hands are appreciated maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

PyGMT authorship policy for Changelog, Zenodo and Publications
6 participants