Skip to content

Commit aeae956

Browse files
seismanweiji14willschlitzer
authored
Add authorship policy (#726)
* 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]>
1 parent 921e7a6 commit aeae956

File tree

1 file changed

+75
-0
lines changed

1 file changed

+75
-0
lines changed

AUTHORSHIP.md

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Authorship guidelines for academic papers and software archives
2+
3+
First of all, we are deeply thankful to everyone who has helped make PyGMT
4+
what it is today. Our goal for this document is to establish guidelines
5+
for giving credit to contributors for their work.
6+
To do so, we will attempt to define:
7+
8+
- Fair and diverse ways of providing recognition for contributors' efforts.
9+
- Define _contributions_ in a broad way: writing code and/or documentation,
10+
providing ideas, fostering the community, etc.
11+
12+
The following are the ways in which individuals who have contributed will be
13+
recognized.
14+
15+
> **Note**: These policies are not set in stone and may be changed to
16+
> accommodate the growth of the project or the preferences of the community.
17+
18+
## The `AUTHORS.md` file
19+
20+
Anyone who has contributed a pull request to the project is welcome to add
21+
themselves to the `AUTHORS.md` file. This file lives in the repository and is
22+
packaged with distributions. This is an optional process.
23+
24+
## Changelog for each release
25+
26+
Every time we make a release, everyone who has made a commit to the repository
27+
since the previous release will be mentioned in the changelog entry. If their
28+
full name is available on GitHub, we will use it. Otherwise, we will use the
29+
GitHub handle. This is a way of saying "Thank you".
30+
31+
## Authorship on Zenodo archives of releases
32+
33+
Anyone who has contributed to the repository (i.e., appears on `git log`) will
34+
be invited to be an author on the Zenodo archive of new releases.
35+
36+
To be included as an author, you *must* add the following to the `AUTHORS.md`
37+
file of the repository:
38+
39+
1. Full name
40+
2. Affiliation (if omitted, we will use "Unaffiliated")
41+
3. ORCID (optional)
42+
43+
The order of authors will be defined by the number of commits to the repository
44+
(`git shortlog -sne`). The order can also be changed on a case-by-case basis.
45+
46+
If you have contributed and do not wish to be included in Zenodo archives,
47+
there are a few options:
48+
49+
1. Don't add yourself to `AUTHORS.md`
50+
2. Remove yourself from `AUTHORS.md`
51+
3. Indicate next to your name on `AUTHORS.md` that you do not wish to be
52+
included with something like `(not included in Zenodo)`.
53+
54+
## Scientific publications (papers)
55+
56+
We aim to write academic papers for most of our software packages. Ideally, we
57+
will publish updated papers for major changes or significant new components of the
58+
package.
59+
60+
To be included as an author on the paper, you *must* satisfy the following
61+
criteria:
62+
63+
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.
64+
2. Have made non-coding contributions, including project administration and decision making.
65+
3. Have participated in the writing and reviewing of the paper.
66+
2. Add your full name, affiliation, and (optionally) ORCID to the paper. These
67+
can be submitted on pull requests to the corresponding paper repository.
68+
3. Write and/or read and review the manuscript in a timely manner and provide
69+
comments on the paper (even if it's just an "OK", but preferably more).
70+
71+
The order of authors will be defined by the number of commits made since the
72+
previous major release that has an associated paper (`git shortlog
73+
vX.0.0...HEAD -sne`). The order of any author who hasn't made any commits will
74+
be decided by all authors. The order can also be changed on a case-by-case
75+
basis.

0 commit comments

Comments
 (0)