diff --git a/.github/ISSUE_TEMPLATE/release_checklist.md b/.github/ISSUE_TEMPLATE/release_checklist.md index 2b633e4fc7f..278ac62c401 100644 --- a/.github/ISSUE_TEMPLATE/release_checklist.md +++ b/.github/ISSUE_TEMPLATE/release_checklist.md @@ -21,8 +21,8 @@ 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 - - [ ] Copy draft changelog from Release Drafter and edit it to look nice + - [ ] 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**: - [ ] At the [PyGMT release page on GitHub](https://github.com/GenericMappingTools/pygmt/releases): @@ -33,12 +33,12 @@ 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/) (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) - - [ ] [Twitter](https://twitter.com/gmt_dev) + - [ ] [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) --- - [ ] Party :tada: (don't tick before all other checkboxes are ticked!) diff --git a/AUTHORSHIP.md b/AUTHORSHIP.md index 058dfb6f176..4d0e82a0fa9 100644 --- a/AUTHORSHIP.md +++ b/AUTHORSHIP.md @@ -42,6 +42,13 @@ 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 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 programming efforts (including reviewing PRs). If you have contributed and do not wish to be included in Zenodo archives, there are a few options: diff --git a/doc/maintenance.md b/doc/maintenance.md index d9f4ed4928e..32f9e607926 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). -5. Edit the list of people who contributed to the release, linking to their + 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 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 account. Sort their names by the number of commits made since the - last release (e.g., use `git shortlog HEAD...v0.1.2 -sne`). -6. Update `README.rst` with new information on the new release version, namely + last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`). +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. + 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