From c8061ad0b23a85c9da6d18f1224f7fff0653e897 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 10 Dec 2020 22:46:35 -0500 Subject: [PATCH 1/4] Get a copy of the authorship policy from https://github.com/fatiando/contributing --- AUTHORSHIP.md | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 AUTHORSHIP.md diff --git a/AUTHORSHIP.md b/AUTHORSHIP.md new file mode 100644 index 00000000000..8c45a2ca57d --- /dev/null +++ b/AUTHORSHIP.md @@ -0,0 +1,74 @@ +# Authorship guidelines for academic papers and software archives + +First of all, we are deeply thankful to everyone who has helped make Fatiando a +Terra what it is today. Our goal for this document is to establish guidelines +for giving credit to contributors for their work. +To do so, we will attempt to define: + +- Fair and diverse ways of providing recognition for contributors' efforts. +- Define _contributions_ in a broad way: writing code and/or documentation, + providing ideas, fostering the community, etc. + +The following are the ways in which individuals who have contributed will be +recognized. + +> **Note**: These policies are not set in stone and may be changed to +> accommodate the growth of the project or the preferences of the community. + +## The `AUTHORS.md` file + +Anyone who has contributed a pull request to the project is welcome to add +themselves to the `AUTHORS.md` file. This file lives in the repository and is +packaged with distributions. This is an optional process. + +## Changelog for each release + +Every time we make a release, everyone who has made a commit to the repository +since the previous release will be mentioned in the changelog entry. If their +full name is available on GitHub, we will use it. Otherwise, we will use the +GitHub handle. This is a way of saying "Thank you". + +## Authorship on Zenodo archives of releases + +Anyone who has contributed to the repository (i.e., appears on `git log`) will +be invited to be an author on the Zenodo archive of new releases. + +To be included as an author, you *must* add the following to the `AUTHORS.md` +file of the repository: + +1. Full name +2. Affiliation (if omitted, we will use "Unaffiliated") +3. ORCID (optional) + +The order of authors will be defined by the number of commits to the repository +(`git shortlog -sne`). The order can also be changed on a case-by-case basis. + +If you have contributed and do not wish to be included in Zenodo archives, +there are a few options: + +1. Don't add yourself to `AUTHORS.md` +2. Remove yourself from `AUTHORS.md` +3. Indicate next to your name on `AUTHORS.md` that you do not wish to be + included with something like `(not included in Zenodo)`. + +## Scientific publications (papers) + +We aim to write academic papers for most of your software packages. Ideally, we +will publish updated papers for major changes or large new components of the +package. + +To be included as an author on the paper, you *must* satisfy the following +criteria: + +1. Have made a contribution to the repository or significant non-coding + contributions. +2. Add your full name, affiliation, and (optionally) ORCID to the paper. These + can be submitted on pull requests to the corresponding paper repository. +3. Write and/or read and review the manuscript in a timely manner and provide + comments on the paper (even if it's just an "OK", but preferably more). + +The order of authors will be defined by the number of commits made since the +previous major release that has an associated paper (`git shortlog +vX.0.0...HEAD -sne`). The order of any author who hasn't made any commits will +be decided by all authors. The order can also be changed on a case-by-case +basis. From 2b5fcb211812f055c5214faa5e38f40da1be56a3 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 10 Dec 2020 22:49:34 -0500 Subject: [PATCH 2/4] Change the project name to PyGMT --- AUTHORSHIP.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/AUTHORSHIP.md b/AUTHORSHIP.md index 8c45a2ca57d..11380befe1a 100644 --- a/AUTHORSHIP.md +++ b/AUTHORSHIP.md @@ -1,7 +1,7 @@ # Authorship guidelines for academic papers and software archives -First of all, we are deeply thankful to everyone who has helped make Fatiando a -Terra what it is today. Our goal for this document is to establish guidelines +First of all, we are deeply thankful to everyone who has helped make PyGMT +what it is today. Our goal for this document is to establish guidelines for giving credit to contributors for their work. To do so, we will attempt to define: From 8f3165405221022f659081461f003fffaa3c2860 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sat, 12 Dec 2020 16:47:13 -0500 Subject: [PATCH 3/4] Update AUTHORSHIP.md Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> --- AUTHORSHIP.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/AUTHORSHIP.md b/AUTHORSHIP.md index 11380befe1a..d3fc65aec72 100644 --- a/AUTHORSHIP.md +++ b/AUTHORSHIP.md @@ -53,8 +53,8 @@ there are a few options: ## Scientific publications (papers) -We aim to write academic papers for most of your software packages. Ideally, we -will publish updated papers for major changes or large new components of the +We aim to write academic papers for most of our software packages. Ideally, we +will publish updated papers for major changes or significant new components of the package. To be included as an author on the paper, you *must* satisfy the following From 021983a3694af9ac18aec0a7ef838993b0017f08 Mon Sep 17 00:00:00 2001 From: Will Schlitzer Date: Wed, 10 Feb 2021 13:26:54 +0000 Subject: [PATCH 4/4] Update contribution explanations --- AUTHORSHIP.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/AUTHORSHIP.md b/AUTHORSHIP.md index d3fc65aec72..43a37453ab5 100644 --- a/AUTHORSHIP.md +++ b/AUTHORSHIP.md @@ -60,8 +60,9 @@ package. To be included as an author on the paper, you *must* satisfy the following criteria: -1. Have made a contribution to the repository or significant non-coding - contributions. +1. Have made multiple and regular contributions to the repository, or the GMT repository, in numerous facets, such as wrapping functions, testing, and/or writing documentation. +2. Have made non-coding contributions, including project administration and decision making. +3. Have participated in the writing and reviewing of the paper. 2. Add your full name, affiliation, and (optionally) ORCID to the paper. These can be submitted on pull requests to the corresponding paper repository. 3. Write and/or read and review the manuscript in a timely manner and provide