From 7c9ae66226a6b2bc5335d34006699af59a4cfb64 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 9 Apr 2025 16:46:31 +0800 Subject: [PATCH 1/3] DOC: Update the 'git shortlog' command to include PR reviews as contributions --- AUTHORSHIP.md | 25 ++++++++++++++----------- doc/maintenance.md | 7 ++++--- 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/AUTHORSHIP.md b/AUTHORSHIP.md index 82a27ab6f07..6c802cc2d13 100644 --- a/AUTHORSHIP.md +++ b/AUTHORSHIP.md @@ -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 @@ -38,10 +38,12 @@ 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 due 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 @@ -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`). +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. diff --git a/doc/maintenance.md b/doc/maintenance.md index 0664a2850eb..769104a876c 100644 --- a/doc/maintenance.md +++ b/doc/maintenance.md @@ -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 From 0bbdf84caadfadef9f698b2aee9bcbca28c05697 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Fri, 11 Apr 2025 06:36:07 +0800 Subject: [PATCH 2/3] Update AUTHORSHIP.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> --- AUTHORSHIP.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORSHIP.md b/AUTHORSHIP.md index 6c802cc2d13..8644aedc902 100644 --- a/AUTHORSHIP.md +++ b/AUTHORSHIP.md @@ -42,7 +42,7 @@ The order of authors will be defined by the number of contributions (including c 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 due not relate to +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), From 3bb70eae5abb8b91c51bd4b6d10d6afe57509c07 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Tue, 15 Apr 2025 09:59:50 +0800 Subject: [PATCH 3/3] Add most recent workshop 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 8644aedc902..b22eeec2866 100644 --- a/AUTHORSHIP.md +++ b/AUTHORSHIP.md @@ -45,8 +45,8 @@ The order can also be changed on a case-by-case basis. The most common reasons f 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