Changelog entry for v0.4.0

[maxrjones]

Description of proposed changes

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

Preview: https://pygmt-git-changelog-release-gmt.vercel.app/changes.html#changelog

Previous release at #1047

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

To do:

• 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 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 #1333

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

[maxrjones]

For updating the citation information, the AUTHORSHIP.md file says that "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." How do I know whether any of the current order reflects a case-by-case basis or whether I should update based on git shortlog -sne?

[weiji14]

How do I know whether any of the current order reflects a case-by-case basis or whether I should update based on git shortlog -sne?

See previous discussion at #1047 (comment). Will leave it up to you to take a first stab at the order :) Just to clarify, that line refers to the Zenodo citation order. The release note authors order should go strictly by git shortlog (and remove the bots).

[maxrjones]

How do I know whether any of the current order reflects a case-by-case basis or whether I should update based on git shortlog -sne?

See previous discussion at #1047 (comment). Will leave it up to you to take a first stab at the order :) Just to clarify, that line refers to the Zenodo citation order. The release note authors order should go strictly by git shortlog (and remove the bots).

OK, I guess I wasn't paying good attention for that release :) Thanks for the note.

[maxrjones]

The index.html result from the python setup.py --long-description | rst2html.py --no-raw > index.html step does not render the badges correctly. Does this need to be corrected?

[maxrjones]

I did the contributors section based on the git log, but I would like to add the three others who were involved in #1070 and #1193 since this method does not recognize team programming. I will do this early tomorrow if there are no objections.

[seisman]

The index.html result from the python setup.py --long-description | rst2html.py --no-raw > index.html step does not render the badges correctly. Does this need to be corrected?

I don't think it's an issue. The badges are working on the pypi site (https://pypi.org/project/pygmt/) and we don't make changes to badges since v0.3.1.

[michaelgrund]

From my side everything looks fine. All open points are considered. Great work!

[core-man]

I did not check the authors, but all the other looks great.

[maxrjones]

Should I wait for Wei Ji to approve as well or is OK to move forward with the comments addressed and the three approvals?

[core-man]

Should I wait for Wei Ji to approve as well or is OK to move forward with the comments addressed and the three approvals?

Perhaps it would better to wait for his approval too, since it does not matter to release v0.4 a few hours earlier or later.

[weiji14]

Just one suggestion, otherwise all good!