From ddca5c3517207a4dd9751d0aefbbc221f7e39dcd Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Sun, 20 Jun 2021 18:00:15 -0400 Subject: [PATCH 1/8] Update release maintainance guide based on reviewer comments for v0.4.0 changelog --- doc/maintenance.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/doc/maintenance.md b/doc/maintenance.md index d9f4ed4928e..cef8f4dab3c 100644 --- a/doc/maintenance.md +++ b/doc/maintenance.md @@ -246,13 +246,21 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html the updated release notes, so that other people can help to review and collaborate on the changelog curation process described next. 4. Edit the change list to remove any trivial changes (updates to the README, - typo fixes, CI configuration, etc). + typo fixes, CI configuration, test updates due to GMT releases, etc). +5. Sort the items within each section (i.e., New Features, Enhancements, etc.) + such that similar items are located near each other (e.g., new wrapped + modules, gallery examples, API docs changes) and that entries within each + group are alphabetical. +6. Move a few important items from the main sections to the highlights section. 5. Edit the list of people who contributed to the release, linking to their GitHub account. Sort their names by the number of commits made since the - last release (e.g., use `git shortlog HEAD...v0.1.2 -sne`). + last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`). 6. Update `README.rst` with new information on the new release version, namely the BibTeX citation, a vX.Y.Z documentation link, and compatibility with - Python and GMT versions. + Python and GMT versions. Follow + [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html#detailed-description) + for compatibility updates. Follow `AUTHORSHIP.md` guidelines for updating + the author list in the BibTeX citation. ### Check the README syntax From b01361b003b48d3568ce289ddbe7a1e8f8489017 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Mon, 21 Jun 2021 21:44:45 -0400 Subject: [PATCH 2/8] Add case-by-case examples to AUTHORSHIP.md --- AUTHORSHIP.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/AUTHORSHIP.md b/AUTHORSHIP.md index 058dfb6f176..1bfd4a8df45 100644 --- a/AUTHORSHIP.md +++ b/AUTHORSHIP.md @@ -42,6 +42,12 @@ file of the repository: 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 reason 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, and writing grants/proposals to support PyGMT. If you have contributed and do not wish to be included in Zenodo archives, there are a few options: From fc48c5db88281e6b15de7eccba8e6187bb72071e Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Mon, 21 Jun 2021 21:49:35 -0400 Subject: [PATCH 3/8] Add notes to release checklist --- .github/ISSUE_TEMPLATE/release_checklist.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 2b633e4fc7f..87eb0aa45e4 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -22,7 +22,7 @@ assignees: '' - [ ] Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt - [ ] Add the documentation link https://github.com/GenericMappingTools/pygmt#documentation-for-other-versions - [ ] Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-python-and-gmt-versions - - [ ] Copy draft changelog from Release Drafter and edit it to look nice + - [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog)) **Release**: - [ ] At the [PyGMT release page on GitHub](https://github.com/GenericMappingTools/pygmt/releases): @@ -33,11 +33,11 @@ assignees: '' **After release**: - [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Usually done automatically by conda-forge's bot] -- [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt +- [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) - [ ] Announce the release on: - - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) + - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (requires moderator status) - [ ] [Major/Minor releases only] GMT [website](https://github.com/GenericMappingTools/website) (News) - - [ ] [ResearchGate](https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools) + - [ ] [ResearchGate](https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools) (after forum announcement) - [ ] [Twitter](https://twitter.com/gmt_dev) --- From f782a1db506884cf1bab8b52bd81fcbfbdb18fc8 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Mon, 21 Jun 2021 21:51:58 -0400 Subject: [PATCH 4/8] Fix grammar --- AUTHORSHIP.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORSHIP.md b/AUTHORSHIP.md index 1bfd4a8df45..92c610fba44 100644 --- a/AUTHORSHIP.md +++ b/AUTHORSHIP.md @@ -42,7 +42,7 @@ file of the repository: 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 reason for case-by-case changes are contributions to the PyGMT +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 From b685e0efdd1c325447fa627a6f1727f46a9be873 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Mon, 21 Jun 2021 21:54:23 -0400 Subject: [PATCH 5/8] Update maintenance guide --- doc/maintenance.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/maintenance.md b/doc/maintenance.md index cef8f4dab3c..d492081449f 100644 --- a/doc/maintenance.md +++ b/doc/maintenance.md @@ -249,8 +249,8 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html typo fixes, CI configuration, test updates due to GMT releases, etc). 5. Sort the items within each section (i.e., New Features, Enhancements, etc.) such that similar items are located near each other (e.g., new wrapped - modules, gallery examples, API docs changes) and that entries within each - group are alphabetical. + modules, 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. 5. Edit the list of people who contributed to the release, linking to their GitHub account. Sort their names by the number of commits made since the From f6bbd671efd2ced17501645351506fa4d3061440 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Wed, 23 Jun 2021 09:51:36 -0400 Subject: [PATCH 6/8] Apply suggestions from code review Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com> Co-authored-by: Yao Jiayuan Co-authored-by: Dongdong Tian --- .github/ISSUE_TEMPLATE/release_checklist.md | 6 +++--- doc/maintenance.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 87eb0aa45e4..739254df0ad 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -21,7 +21,7 @@ assignees: '' - [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher - [ ] Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt - [ ] Add the documentation link https://github.com/GenericMappingTools/pygmt#documentation-for-other-versions - - [ ] Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-python-and-gmt-versions + - [ ] Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-gmt-and-pythonnumpy-versions - [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog)) **Release**: @@ -35,10 +35,10 @@ assignees: '' - [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Usually done automatically by conda-forge's bot] - [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) - [ ] Announce the release on: - - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (requires moderator status) + - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this first! requires moderator status) - [ ] [Major/Minor releases only] GMT [website](https://github.com/GenericMappingTools/website) (News) - [ ] [ResearchGate](https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools) (after forum announcement) - - [ ] [Twitter](https://twitter.com/gmt_dev) + - [ ] [Twitter](https://twitter.com/gmt_dev) (after forum announcement) --- - [ ] Party :tada: (don't tick before all other checkboxes are ticked!) diff --git a/doc/maintenance.md b/doc/maintenance.md index d492081449f..32f9e607926 100644 --- a/doc/maintenance.md +++ b/doc/maintenance.md @@ -252,10 +252,10 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html modules, 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. -5. Edit the list of people who contributed to the release, linking to their +7. Edit the list of people who contributed to the release, linking to their GitHub account. Sort their names by the number of commits made since the last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`). -6. Update `README.rst` with new information on the new release version, namely +8. Update `README.rst` with new information on the new release version, namely the BibTeX citation, a vX.Y.Z documentation link, and compatibility with Python and GMT versions. Follow [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html#detailed-description) From d5d1df0609825de1ac1eb474ca468e781f169976 Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Wed, 23 Jun 2021 10:07:58 -0400 Subject: [PATCH 7/8] Update release checklist with hackmd note --- .github/ISSUE_TEMPLATE/release_checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 739254df0ad..278ac62c401 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -35,7 +35,7 @@ assignees: '' - [ ] Update conda-forge [pygmt-feedstock](https://github.com/conda-forge/pygmt-feedstock) [Usually done automatically by conda-forge's bot] - [ ] Bump PyGMT version on https://github.com/GenericMappingTools/try-gmt (after conda-forge update) - [ ] Announce the release on: - - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this first! requires moderator status) + - [ ] GMT [forum](https://forum.generic-mapping-tools.org/c/news/) (do this announcement first! draft on https://hackmd.io/@pygmt. requires moderator status) - [ ] [Major/Minor releases only] GMT [website](https://github.com/GenericMappingTools/website) (News) - [ ] [ResearchGate](https://www.researchgate.net/project/PyGMT-A-Python-interface-for-the-Generic-Mapping-Tools) (after forum announcement) - [ ] [Twitter](https://twitter.com/gmt_dev) (after forum announcement) From ff27ac58228bb2ddbae7c197837b067f1c625e1d Mon Sep 17 00:00:00 2001 From: Meghan Jones Date: Wed, 23 Jun 2021 10:09:59 -0400 Subject: [PATCH 8/8] Add team programming to authorship guide --- AUTHORSHIP.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/AUTHORSHIP.md b/AUTHORSHIP.md index 92c610fba44..4d0e82a0fa9 100644 --- a/AUTHORSHIP.md +++ b/AUTHORSHIP.md @@ -47,7 +47,8 @@ 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, and writing grants/proposals to support PyGMT. +the 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 few options: