Changelog entry for v0.5.0

[willschlitzer]

Description of proposed changes

This PR is a draft changelog entry for v0.5.0.

Previous release at #1414

Changelog made by following the instructions at https://github.com/GenericMappingTools/pygmt/blob/main/doc/maintenance.md#updating-the-changelog

TODO:

• Update the DOI badge
• Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt
• Add the documentation link https://github.com/GenericMappingTools/pygmt#documentation-for-other-versions
• Add highlights
• Update with any remaining PRs merged before release
• Edit the change list to remove any trivial changes (updates to the README, typo fixes, CI configuration, etc)
• 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).

Relates to #1576

Reminders

• Run make format and make check to make sure the code follows the style guide.
• Add tests for new features or tests that would have caught the bug that you're fixing.
• Add new public functions/methods/classes to doc/api/index.rst.
• Write detailed docstrings for all functions/methods.
• If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

• /format: automatically format and lint the code
• /test-gmt-dev: run full tests on the latest GMT development version

[willschlitzer]

@GenericMappingTools/gmt-maintainers I'm struggling to identify highlights in the changelog; other than Python 3.10 support, anything in particular that we should note?

[weiji14]

Since Yohai has 7 commits, I think we should bump his name up the list (to be after Jiayuan) on the BibTeX and CITATION.cff file. This is what I get from git shortlog -sne (after merging duplicate entries):

303  Dongdong Tian <seisman.info@gmail.com>
256  Leonardo Uieda <leouieda@gmail.com>
160  Wei Ji <23487320+weiji14@users.noreply.github.com>
105  Will Schlitzer <schlitzer90@gmail.com>
 64  Michael Grund <23025878+michaelgrund@users.noreply.github.com>
 58  Meghan Jones <meghanj@hawaii.edu>
 41  dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
 32  Yao Jiayuan <coreman.seism@gmail.com>
 15  Liam Toney <38269494+liamtoney@users.noreply.github.com>
  7  yohaimagen <mayochay@gmail.com>
  3  kmaterna <kathrynmaterna@gmail.com>
  2  Abhishek Anant <81291713+itsabhianant@users.noreply.github.com>
  2  Amanda Leaman <77039253+arleaman@users.noreply.github.com>
  2  Andrey Shmakov <akshmakov@gmail.com>
  2  Claudio Satriano <satriano@gmail.com>
  2  Conor Bacon <conor.bacon@gmail.com>
  2  MichaeINeumann <81390813+MichaeINeumann@users.noreply.github.com>
  2  Noor Buchi <55197145+noorbuchi@users.noreply.github.com>
  2  Shivani chauhan <56837749+xdshivani@users.noreply.github.com>
  2  Tyler Newton <54011699+tjnewton@users.noreply.github.com>
  2  alperen-kilic <58446832+alperen-kilic@users.noreply.github.com>
  2  carocamargo <47150926+carocamargo@users.noreply.github.com>
  2  daroari <60489499+daroari@users.noreply.github.com>
  2  obaney <81708927+obaney@users.noreply.github.com>
  2  srijac <50964856+srijac@users.noreply.github.com>
  1  Alicia Ngoc Diep Ha <58379930+aliciaha1997@users.noreply.github.com>
  1  Andrés Ignacio Torres <andresitorresm@gmail.com>
  1  Becky Salvage <60942514+BeckySalvage@users.noreply.github.com>
  1  Brook <btozer@ucsd.edu>
  1  Cody Woodson <dovacody@gmail.com>
  1  Emily McMullan <55964550+eemcmullan@users.noreply.github.com>
  1  Jamie J Quinn <JamieJQuinn@users.noreply.github.com>
  1  Kadatatlu Kishore <vskishore408@gmail.com>
  1  Loïc Houpert <10154151+lhoupert@users.noreply.github.com>
  1  Malte Ziebarth <malte.ziebarth@fmvkb.de>
  1  Mark Wieczorek <mark.a.wieczorek@gmail.com>
  1  Philipp Loose <37411699+xibalba01@users.noreply.github.com>

Also happy to debate on whether we switch any of the ordering (e.g. make @seisman first author 🙂)

[willschlitzer]

I'm fine with either way of doing it. I know that we have previously put @leouieda at the front because he created this project, but I think @seisman, @weiji14, and @meghanrjones are the three most active on this project at this time when it comes to providing feedback and completing reviews. I moved both Meghan and Yohai up in the list.

[weiji14]

Yep, the order looks ok to me now (though happy to discuss). Please also update the CITATION.cff file with the new author order (and apply the patch from #1592 (comment)) as mentioned in #1594 (comment).

[willschlitzer]

Done in bbbc0ac

[leouieda]

A bit late but just wanted to say that I'm perfectly happy not being first since @seisman @weiji14 @meghanrjones and others deserve it more than I do 👍🏽 Creating something is easy, keeping it going and growing like this is where the real work is 🙂

[weiji14]

Thanks Leo for chiming in! I would argue that you still deserve the first spot since the original GMT C to Python interface (via ctypes) is so foundational (some of that 4+ year old code is still more or less intact at https://github.com/GenericMappingTools/pygmt/blame/v0.5.0/pygmt/clib/session.py and working!!!), and this is what makes this 'PyGMT' package so good compared to the other gmtpy/pygmt wrappers people have tried to come up with previously.

But again, I don't want to get into an author ordering debate, I'm just as happy being on third place, last place, alphabetically ordered or have a random number generator sort things out. We've discussed the AUTHORSHIP.md policy before at #726 (comment), and could edit it again if needed, especially when the time comes closer to getting a software publication out.

[weiji14]

Approving because I'm heading to bed (will be back in ~8 hours), please get a second or third reviewer to approve before merging. Thanks again @willschlitzer for all the work!

[weiji14]

Oh, and if anyone has any other item they want to highlight, feel free to suggest it to @willschlitzer.

[maxrjones]

Nice, @willschlitzer! Just a couple sorting suggestions and adding Jamie Quinn based on their recent PR.