Skip to content

Update the AUTHORSHIP and Maintainers' Guides to reflect co-author contributions #3904

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.

Sign up for GitHub

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

Merged
seisman merged 5 commits into from
Apr 15, 2025
Merged

Update the AUTHORSHIP and Maintainers' Guides to reflect co-author contributions #3904

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7c9ae66
DOC: Update the 'git shortlog' command to include PR reviews as contr…
seisman Apr 9, 2025
0bbdf84
Update AUTHORSHIP.md
seisman Apr 10, 2025
f658134
Merge branch 'main' into author-shortlog
seisman Apr 14, 2025
a77684e
Merge branch 'main' into author-shortlog
seisman Apr 15, 2025
3bb70ea
Add most recent workshop
seisman Apr 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions AUTHORSHIP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@ 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".
Every time we make a release, everyone who has made a contribution (commits or PR
reviews) to the repository since the previous release will be mentioned in the changelog.
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

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

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. The most
common reasons for case-by-case changes are contributions to the PyGMT project that due
not relate to commit numbers, including developing PyGMT lessons such as the
The order of authors will be defined by the number of contributions (including commits
and PR reviews) to the repository
(`git shortlog -sne --group=author --group=trailer:co-authored-by`).
The order can also be changed on a case-by-case basis. The most common reasons for
case-by-case changes are contributions to the PyGMT project that do not relate to
commit numbers, including developing PyGMT lessons such as the
[ROSES unit](https://www.youtube.com/watch?v=SSIGJEe0BIk), organizing workshops/sprints
such as the [FOSS4G Workshop](https://github.com/GenericMappingTools/foss4g2019oceania),
the 2020 and 2021 SciPy sprints, writing grants/proposals to support PyGMT, and team
such as the [AGU24 Workshop](https://github.com/GenericMappingTools/agu24workshop) or
2020 and 2021 SciPy sprints, writing grants/proposals to support PyGMT, and team
programming efforts (including reviewing PRs).

If you have contributed and do not wish to be included in Zenodo archives, there are a
Expand Down Expand Up @@ -78,6 +80,7 @@ To be included as an author on the paper, you *must* satisfy the following crite
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.
major release that has an associated paper
(`git shortlog vX.Y.Z..HEAD -sne --group=author --group=trailer:co-authored-by`).
Copy link
Member Author

@seisman seisman Apr 10, 2025

Choose a reason for hiding this comment

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

Please note that we inconsistently used git shortlog vX.0.0...HEAD -sne and git shortlog HEAD...v0.4.0 -sne in the old versions.

In the new version, I've changed them to git shortlog vX.Y.Z..HEAD (tag before HEAD vs HEAD before tag, .. vs ...). Their differences are summaried below (from ChatGPT):

Command Meaning Use Case
git shortlog v0.14.0..HEAD Commits in HEAD but not in v0.14.0 ✅ Changes since the tag
git shortlog HEAD..v0.14.0 Commits in v0.14.0 but not in HEAD 🔄 Unusual — usually empty if HEAD is ahead
git shortlog v0.14.0...HEAD Commits in v0.14.0 or HEAD, but not both (symmetric difference) 🔍 Compare diverged histories
git shortlog HEAD...v0.14.0 Same as above — order doesn’t matter 🔍 Same as above

The three-dot version doens't work well for patch releases like v0.14.1/v0.14.2.

Copy link
Member

@yvonnefroehlich yvonnefroehlich Apr 10, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Uhh, did not realize so far, that there are two and three dot versions 😅.

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