Skip to content

Commit 2fc9a9c

Browse files
authored
Reformat AUTHORSHIP.md to wrap lines at 88 characters (#3899)
1 parent dbaacd6 commit 2fc9a9c

File tree

1 file changed

+51
-58
lines changed

1 file changed

+51
-58
lines changed

AUTHORSHIP.md

Lines changed: 51 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,90 +1,83 @@
11
# Authorship guidelines for academic papers and software archives
22

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:
3+
First of all, we are deeply thankful to everyone who has helped to make PyGMT what it
4+
is today. Our goal for this document is to establish guidelines for giving credit to
5+
contributors for their work. To do so, we will attempt to define:
76

87
- 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.
8+
- Define _contributions_ in a broad way: writing code and/or documentation, providing
9+
ideas, fostering the community, etc.
1110

12-
The following are the ways in which individuals who have contributed will be
13-
recognized.
11+
The following are the ways in which individuals who have contributed will be recognized.
1412

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.
13+
> **Note**: These policies are not set in stone and may be changed to accommodate the
14+
> growth of the project or the preferences of the community.
1715
1816
## The `AUTHORS.md` file
1917

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.
18+
Anyone who has contributed a pull request to the project is welcome to add themselves to
19+
the `AUTHORS.md` file. This file lives in the repository and is packaged with
20+
distributions. This is an optional process.
2321

2422
## Changelog for each release
2523

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".
24+
Every time we make a release, everyone who has made a commit to the repository since the
25+
previous release will be mentioned in the changelog entry. If their full name is
26+
available on GitHub, we will use it. Otherwise, we will use the GitHub handle. This is a
27+
way of saying "Thank you".
3028

3129
## Authorship on Zenodo archives of releases
3230

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.
31+
Anyone who has contributed to the repository (i.e., appears on `git log`) will be
32+
invited to be an author on the Zenodo archive of new releases.
3533

36-
To be included as an author, you *must* add the following to the `AUTHORS.md`
37-
file of the repository:
34+
To be included as an author, you *must* add the following to the `AUTHORS.md` file of
35+
the repository:
3836

3937
1. Full name (and a link to your website or GitHub page)
4038
2. [ORCID](https://orcid.org) (optional)
4139
3. Affiliation (if omitted, we will use "Unaffiliated")
4240

4341
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-
The most common reasons for case-by-case changes are contributions to the PyGMT
46-
project that due not relate to commit numbers, including developing PyGMT
47-
lessons such as the [ROSES unit](https://www.youtube.com/watch?v=SSIGJEe0BIk),
48-
organizing workshops/sprints such as the
49-
[FOSS4G Workshop](https://github.com/GenericMappingTools/foss4g2019oceania),
50-
the 2020 and 2021 SciPy sprints, writing grants/proposals to support PyGMT,
51-
and team programming efforts (including reviewing PRs).
52-
53-
If you have contributed and do not wish to be included in Zenodo archives,
54-
there are a few options:
42+
(`git shortlog -sne`). The order can also be changed on a case-by-case basis. The most
43+
common reasons for case-by-case changes are contributions to the PyGMT project that due
44+
not relate to commit numbers, including developing PyGMT lessons such as the
45+
[ROSES unit](https://www.youtube.com/watch?v=SSIGJEe0BIk), organizing workshops/sprints
46+
such as the [FOSS4G Workshop](https://github.com/GenericMappingTools/foss4g2019oceania),
47+
the 2020 and 2021 SciPy sprints, writing grants/proposals to support PyGMT, and team
48+
programming efforts (including reviewing PRs).
49+
50+
If you have contributed and do not wish to be included in Zenodo archives, there are a
51+
few options:
5552

5653
1. Don't add yourself to `AUTHORS.md`
5754
2. Remove yourself from `AUTHORS.md`
58-
3. Indicate next to your name on `AUTHORS.md` that you do not wish to be
59-
included with something like `(not included in Zenodo)`.
55+
3. Indicate next to your name on `AUTHORS.md` that you do not wish to be included with
56+
something like `(not included in Zenodo)`.
6057

61-
Note that authors included in the Zenodo archive will also have their name
62-
listed in the `CITATION.cff` file. This is a machine (and human) readable file
63-
that enables people to cite the PyGMT software easily, and the file will be
64-
updated by the PyGMT maintainers each time a new release is made.
58+
Note that authors included in the Zenodo archive will also have their name listed in the
59+
`CITATION.cff` file. This is a machine (and human) readable file that enables people to
60+
cite the PyGMT software easily, and the file will be updated by the PyGMT maintainers
61+
each time a new release is made.
6562

6663
## Scientific publications (papers)
6764

68-
We aim to write academic papers for most of our software packages. Ideally, we
69-
will publish updated papers for major changes or significant new components of
70-
the package.
65+
We aim to write academic papers for most of our software packages. Ideally, we will
66+
publish updated papers for major changes or significant new components of the package.
7167

72-
To be included as an author on the paper, you *must* satisfy the following
73-
criteria:
68+
To be included as an author on the paper, you *must* satisfy the following criteria:
7469

75-
1. Have made multiple and regular contributions to the repository, or the GMT
76-
repository, in numerous facets, such as wrapping functions, testing, and/or
77-
writing documentation.
78-
2. Have made non-coding contributions, including project administration and
79-
decision making.
70+
1. Have made multiple and regular contributions to the repository, or the GMT repository,
71+
in numerous facets, such as wrapping functions, testing, and/or writing documentation.
72+
2. Have made non-coding contributions, including project administration and decision
73+
making.
8074
3. Have participated in the writing and reviewing of the paper.
81-
4. Add your full name, affiliation, and (optionally) ORCID to the paper. These
82-
can be submitted on pull requests to the corresponding paper repository.
83-
5. Write and/or read and review the manuscript in a timely manner and provide
84-
comments on the paper (even if it's just an "OK", but preferably more).
85-
86-
The order of authors will be defined by the number of commits made since the
87-
previous major release that has an associated paper (`git shortlog
88-
vX.0.0...HEAD -sne`). The order of any author who hasn't made any commits will
89-
be decided by all authors. The order can also be changed on a case-by-case
90-
basis.
75+
4. Add your full name, affiliation, and (optionally) ORCID to the paper. These can be
76+
submitted on pull requests to the corresponding paper repository.
77+
5. Write and/or read and review the manuscript in a timely manner and provide comments
78+
on the paper (even if it's just an "OK", but preferably more).
79+
80+
The order of authors will be defined by the number of commits made since the previous
81+
major release that has an associated paper (`git shortlog vX.0.0...HEAD -sne`). The order
82+
of any author who hasn't made any commits will be decided by all authors. The order can
83+
also be changed on a case-by-case basis.

0 commit comments

Comments
 (0)