Skip to content

Commit 16f30cb

Browse files
seismanyvonnefroehlichweiji14
authored
Update the AUTHORSHIP and Maintainers' Guides to reflect co-author contributions (#3904)
Co-authored-by: Yvonne Fröhlich <[email protected]> Co-authored-by: Wei Ji <[email protected]>
1 parent b2edd1f commit 16f30cb

File tree

2 files changed

+20
-16
lines changed

2 files changed

+20
-16
lines changed

AUTHORSHIP.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ distributions. This is an optional process.
2121

2222
## Changelog for each release
2323

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

2929
## Authorship on Zenodo archives of releases
3030

@@ -38,13 +38,15 @@ the repository:
3838
2. [ORCID](https://orcid.org) (optional)
3939
3. Affiliation (if omitted, we will use "Unaffiliated")
4040

41-
The order of authors will be defined by the number of commits to the repository
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
41+
The order of authors will be defined by the number of contributions (including commits
42+
and PR reviews) to the repository
43+
(`git shortlog -sne --group=author --group=trailer:co-authored-by`).
44+
The order can also be changed on a case-by-case basis. The most common reasons for
45+
case-by-case changes are contributions to the PyGMT project that do not relate to
46+
commit numbers, including developing PyGMT lessons such as the
4547
[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+
such as the [AGU24 Workshop](https://github.com/GenericMappingTools/agu24workshop) or
49+
2020 and 2021 SciPy sprints, writing grants/proposals to support PyGMT, and team
4850
programming efforts (including reviewing PRs).
4951

5052
If you have contributed and do not wish to be included in Zenodo archives, there are a
@@ -78,6 +80,7 @@ To be included as an author on the paper, you *must* satisfy the following crite
7880
on the paper (even if it's just an "OK", but preferably more).
7981

8082
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.
83+
major release that has an associated paper
84+
(`git shortlog vX.Y.Z..HEAD -sne --group=author --group=trailer:co-authored-by`).
85+
The order of any author who hasn't made any commits will be decided by all authors. The
86+
order can also be changed on a case-by-case basis.

doc/maintenance.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -254,9 +254,10 @@ publishing the actual release notes at [](changes.md).
254254
modules and methods, gallery examples, API docs changes) and entries within each group
255255
are alphabetical.
256256
6. Move a few important items from the main sections to the Highlights section.
257-
7. Edit the list of people who contributed to the release, linking to their
258-
GitHub accounts. Sort their names by the number of commits made since the
259-
last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`).
257+
7. Edit the list of people who contributed to the release, linking to their GitHub
258+
accounts. Sort their names by the number of contributions (including commits and PR
259+
reviews) made since the last release (e.g., use
260+
`git shortlog vX.Y.Z..HEAD -sne --group=author --group=trailer:co-authored-by`).
260261
8. Update `doc/minversions.md` with new information on the new release version,
261262
including a vX.Y.Z documentation link, and minimum required versions of GMT, Python
262263
and core package dependencies (NumPy, pandas, Xarray). Follow

0 commit comments

Comments
 (0)