Changelog entry for v0.3.1 release #1047

willschlitzer · 2021-03-13T09:13:46Z

Description of proposed changes

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

Previous release at #887

Changelog made by following the instructions at https://github.com/GenericMappingTools/pygmt/blob/master/MAINTENANCE.md#updating-the-changelog. The changelog itself includes the following sections:

New features
Enhancements
Documentation
Bug fixes
Maintenance
List of Contributors

TODO:

Add Zenodo DOI link once it's reserved.
Add a new entry in doc/_static/version_switch.js for documentation switcher
Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt
Set release date

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 · 2021-03-13T13:32:35Z

@weiji14 @seisman It looks like the auto-generated changelog is already formatting the associated links; do I still need to run sed -i.bak -E 's$$#([0-9]*)$$(`#\1 <https://github.com/GenericMappingTools/pygmt/pull/\1>`__)$g' changes.rst?

doc/changes.md

Co-authored-by: Yao Jiayuan <[email protected]>

seisman · 2021-03-13T15:50:20Z

It looks like the auto-generated changelog is already formatting the associated links; do I still need to run sed -i.bak -E 's$$#([0-9]*)$$(`#\1 <https://github.com/GenericMappingTools/pygmt/pull/\1>`__)$g' changes.rst?

No need.

README.rst

doc/changes.md

Co-authored-by: Dongdong Tian <[email protected]>

doc/changes.md

Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>

doc/changes.md

weiji14 · 2021-03-14T09:13:57Z

doc/changes.md

+* 🎉 **Multiple bug fixes and a reorganized gallery** 🎉
+* New gallery example for Cartesian, circular, and geographic vectors ([#950](https://github.com/GenericMappingTools/pygmt/pull/950))


Then I'd like to recommend another gallery example: Vector heads and tails. It is cool and useful. How do you think ?@weiji14 @willschlitzer

Yep, actually #950 and #890 are part of the vectors issue at #892 so maybe we could merge it into one bullet point?

For another point, how about mentioning the gallery reorganization #995? There was quite a bit of work (and debate) that went into that!

Yep, actually #950 and #890 are part of the vectors issue at #892 so maybe we could merge it into one bullet point?

Sounds good.

For another point, how about mentioning the gallery reorganization #995? There was quite a bit of work (and debate) that went into that!

I agree, but the first line says:

🎉 Multiple bug fixes and a reorganized gallery 🎉

So can we still highlight it again?

Added in 444ef30

I agree, but the first line says:

tada Multiple bug fixes and a reorganized gallery tada

So can we still highlight it again?

Or we can change that first line to say ":tada: Multiple bug fixes and an improved gallery :tada:" :shrug:

Alternatively, we can mention the Twitter account 🐦 https://twitter.com/gmt_software What do people think?

Or we can change that first line to say " Multiple bug fixes and an improved gallery "

That's great. Will update https://hackmd.io/@pygmt/ryt7DI5md when other maintainers approve this PR.

Great, thanks for starting that changelog @core-man! I've added a nice link so using https://hackmd.io/@pygmt/v0-3-1_announcement now:

From my point of view, the most important changes are covered 😉.

doc/changes.md

Co-authored-by: Wei Ji <[email protected]>

doc/changes.md

Co-authored-by: Wei Ji <[email protected]>

weiji14

Hopefully the last nitpick, sorting the contributor list by number of commits, and tied ones are sorted alphabetically as per git shortlog HEAD...v0.3.0 -sne (on the master branch).

   25  Dongdong Tian
    19  Yao Jiayuan
    14  Wei Ji
     9  Meghan Jones
     8  Michael Grund
     8  Will Schlitzer
     3  dependabot[bot]
     2  Liam Toney
     2  kmaterna
     1  Alicia Ngoc Diep Ha
     1  Michael Grund
     1  Tawanda
     1  Yao Jiayuan (姚家园)

👋 Everyone else, preview things at https://pygmt-git-v031-release-gmt.vercel.app/changes.html#release-v0-3-1-2021-03-14 to see if there's anything amiss.

doc/changes.md

core-man · 2021-03-14T10:42:10Z

Following @weiji14 , I checked Citing PyGMT and authorship on Zenodo archives of releases at AUTHORSHIP.md:

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.

$ git shortlog -sne
   256  Leonardo Uieda <[email protected]>
   225  Dongdong Tian <[email protected]>
   112  Wei Ji <[email protected]>
    63  Will Schlitzer <[email protected]>
    19  Yao Jiayuan <[email protected]>
    16  Michael Grund <[email protected]>
    15  Liam Toney <[email protected]>
    12  Meghan Jones <[email protected]>
     9  dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
     3  kmaterna <[email protected]>
     2  Andrey Shmakov <[email protected]>
     2  Conor Bacon <[email protected]>
     2  Tyler Newton <[email protected]>
     1  Alicia Ngoc Diep Ha <[email protected]>
     1  Brook <[email protected]>
     1  Claudio Satriano <[email protected]>
     1  Cody Woodson <[email protected]>
     1  Malte Ziebarth <[email protected]>
     1  Mark Wieczorek <[email protected]>
     1  Michael Grund <[email protected]>
     1  Philipp Loose <[email protected]>
     1  Tawanda <[email protected]>
     1  Yao Jiayuan (姚家园) <[email protected]>
     1  carocamargo <[email protected]>

It seems that we also need to update the authors for the citation. Am I right? Below is original authors in citatin:

Uieda, Leonardo and
Tian, Dongdong and
Leong, Wei Ji and
---
Schlitzer, William and
Yao, Jiayuan and
Grund, Michael and
Toney, Liam and
---
Jones, Meghan and
Materna, Kathryn and
Newton, Tyler and
Ziebarth, Malte and
Wessel, Paul

core-man · 2021-03-14T10:46:37Z

README.rst

                      Toney, Liam and
                      Schlitzer, William and
                      Grund, Michael and
+                      Yao, Jiayuan and


Suggested change

Toney, Liam and

Schlitzer, William and

Grund, Michael and

Yao, Jiayuan and

Schlitzer, William and

Yao, Jiayuan and

Grund, Michael and

Toney, Liam and

I had based this off number of commits yesterday; I'll put
Toney, Liam and Schlitzer, William and Yao, Jiayuan and Grund, Michael and

In the v0.3.0 release we put @liamtoney up higher because of his ROSES video, which may not count towards his commits but has significantly enhanced the project. Ping @GenericMappingTools/python for input, but I think he should remain where he is in the order because he is spearheading the SciPy session.

Following @weiji14 , I checked Citing PyGMT and authorship on Zenodo archives of releases at AUTHORSHIP.md:

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.

Yes, on a first order, we sort things by the number of commits. But pay attention to the next sentence "The order can also be changed on a case-by-case basis". The idea is that contributions are not just about commits but also the other things people do. For example, Liam put a lot of work into the ROSES tutorial (the video on the front page) and Meghan has done lots of things behind the scenes such as funding applications and setting up accounts.

I don't want to get too fired up about name ordering, but it's really up to you all to negotiate what you think is best. Just stating that there are other factors to consider :)

Changes pushed in 8fef314

That's reasonable. I also think Liam and Meghan have conducted a lot of work beyond just code commit. Good to know we can pay attention to those contributions a lot. Actually, I begin to know PyGMT from his ROSES tutorial. 😄

Actually, I begin to know PyGMT from his ROSES tutorial.

Me too! Thanks Liam!

Everythin fine for me 😉.

core-man · 2021-03-14T10:50:40Z

I quickly reviewed the changelog again and have no more comments.

weiji14

Let's get this merged! Zenodo is at the ready too!

willschlitzer · 2021-03-14T11:10:17Z

Let's get this merged! Zenodo is at the ready too!

I can't "Squash and merge" because of the required tests; can you disable them/merge this PR?

weiji14 · 2021-03-14T11:11:44Z

Yep, I can merge this one in (unless someone has any last minute issues). About time we give you admin permissions @willschlitzer 😄

Patch release with multiple bug fixes and an improved gallery. * Update version_switch.js for v0.3.1 release * Add changelog entry to changes.md * Update v0.3.1 release highlights * reorganize contributor list * reorganize author list Co-authored-by: Yao Jiayuan <[email protected]> Co-authored-by: Dongdong Tian <[email protected]> Co-authored-by: Wei Ji <[email protected]>

willschlitzer added 2 commits March 13, 2021 09:05

Update README.rst for v0.3.1 release

a38d9d3

Update version_switch.js for v0.3.1 release

9d058a4

willschlitzer added the skip-changelog Skip adding Pull Request to changelog label Mar 13, 2021

willschlitzer added this to the 0.3.1 milestone Mar 13, 2021

Add changelog entry to changes.md

a783324

vercel bot temporarily deployed to Preview March 13, 2021 13:34 Inactive

Minor change log updates

6763056

vercel bot temporarily deployed to Preview March 13, 2021 13:43 Inactive

core-man reviewed Mar 13, 2021

View reviewed changes

doc/changes.md Outdated Show resolved Hide resolved

Update doc/changes.md

46d58f3

Co-authored-by: Yao Jiayuan <[email protected]>

vercel bot temporarily deployed to Preview March 13, 2021 15:38 Inactive

seisman reviewed Mar 13, 2021

View reviewed changes

README.rst Outdated Show resolved Hide resolved

doc/changes.md Outdated Show resolved Hide resolved

Update README.rst

4a9ebef

Co-authored-by: Dongdong Tian <[email protected]>

vercel bot temporarily deployed to Preview March 13, 2021 23:33 Inactive

seisman reviewed Mar 14, 2021

View reviewed changes

doc/changes.md Outdated Show resolved Hide resolved

seisman added maintenance Boring but important stuff for the core devs and removed maintenance Boring but important stuff for the core devs labels Mar 14, 2021

weiji14 reviewed Mar 14, 2021

View reviewed changes

doc/changes.md Outdated Show resolved Hide resolved

willschlitzer added 2 commits March 14, 2021 07:38

add Alicia Ngoc Diep Ha to contributors

001ab97

Merge remote-tracking branch 'origin/v0.3.1-release' into v0.3.1-release

956a8dc

vercel bot temporarily deployed to Preview March 14, 2021 07:38 Inactive

willschlitzer and others added 3 commits March 14, 2021 07:39

add Tawanda Moyo to contributors

88a0f8a

Apply suggestions from code review

27c5f50

Co-authored-by: Wei Ji <[email protected]> Co-authored-by: Dongdong Tian <[email protected]>

Merge branch 'master' into v0.3.1-release

ccca7e6

willschlitzer marked this pull request as ready for review March 14, 2021 07:49

vercel bot temporarily deployed to Preview March 14, 2021 07:55 Inactive

weiji14 reviewed Mar 14, 2021

View reviewed changes

doc/changes.md Outdated Show resolved Hide resolved

Update release highlights

8f10941

weiji14 reviewed Mar 14, 2021

View reviewed changes

Update v0.3.1 highlights

444ef30

vercel bot temporarily deployed to Preview March 14, 2021 09:19 Inactive

weiji14 reviewed Mar 14, 2021

View reviewed changes

doc/changes.md Outdated Show resolved Hide resolved

Update doc/changes.md

c1ce366

Co-authored-by: Wei Ji <[email protected]>

vercel bot temporarily deployed to Preview March 14, 2021 09:27 Inactive

willschlitzer added 2 commits March 14, 2021 09:31

Update v0.3.1 highlights wording

85f8553

Merge remote-tracking branch 'origin/v0.3.1-release' into v0.3.1-release

80f6ee7

vercel bot temporarily deployed to Preview March 14, 2021 09:35 Inactive

weiji14 reviewed Mar 14, 2021

View reviewed changes

doc/changes.md Outdated Show resolved Hide resolved

Update doc/changes.md

5228afa

Co-authored-by: Wei Ji <[email protected]>

vercel bot temporarily deployed to Preview March 14, 2021 09:52 Inactive

core-man mentioned this pull request Mar 14, 2021

Release PyGMT v0.3.1 #987

Closed

23 tasks

weiji14 reviewed Mar 14, 2021

View reviewed changes

doc/changes.md Outdated Show resolved Hide resolved

doc/changes.md Outdated Show resolved Hide resolved

willschlitzer added 2 commits March 14, 2021 10:39

reorganize contributor list

958ce13

Merge remote-tracking branch 'origin/v0.3.1-release' into v0.3.1-release

7f7f968

vercel bot temporarily deployed to Preview March 14, 2021 10:39 Inactive

core-man reviewed Mar 14, 2021

View reviewed changes

reorganize author list

8fef314

vercel bot temporarily deployed to Preview March 14, 2021 10:51 Inactive

weiji14 approved these changes Mar 14, 2021

View reviewed changes

weiji14 merged commit 8e2b2e6 into master Mar 14, 2021

weiji14 deleted the v0.3.1-release branch March 14, 2021 11:17

weiji14 mentioned this pull request Jun 19, 2021

Changelog entry for v0.4.0 #1341

Merged

13 tasks

core-man mentioned this pull request Jun 23, 2021

Update release documentation based on review comments from v0.4.0 #1346

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Changelog entry for v0.3.1 release #1047

Changelog entry for v0.3.1 release #1047

willschlitzer commented Mar 13, 2021 •

edited

Loading

willschlitzer commented Mar 13, 2021

seisman commented Mar 13, 2021

weiji14 Mar 14, 2021

core-man Mar 14, 2021

willschlitzer Mar 14, 2021

weiji14 Mar 14, 2021

weiji14 Mar 14, 2021 •

edited

Loading

core-man Mar 14, 2021

weiji14 Mar 14, 2021

michaelgrund Mar 14, 2021

weiji14 left a comment •

edited

Loading

core-man commented Mar 14, 2021 •

edited

Loading

core-man Mar 14, 2021

willschlitzer Mar 14, 2021

weiji14 Mar 14, 2021

willschlitzer Mar 14, 2021

core-man Mar 14, 2021 •

edited

Loading

willschlitzer Mar 14, 2021

michaelgrund Mar 14, 2021

core-man commented Mar 14, 2021

weiji14 left a comment

willschlitzer commented Mar 14, 2021 •

edited

Loading

weiji14 commented Mar 14, 2021

		* 🎉 Multiple bug fixes and a reorganized gallery 🎉
		* New gallery example for Cartesian, circular, and geographic vectors ([#950](https://github.com/GenericMappingTools/pygmt/pull/950))

Changelog entry for v0.3.1 release #1047

Changelog entry for v0.3.1 release #1047

Conversation

willschlitzer commented Mar 13, 2021 • edited Loading

willschlitzer commented Mar 13, 2021

seisman commented Mar 13, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weiji14 Mar 14, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

weiji14 left a comment • edited Loading

Choose a reason for hiding this comment

core-man commented Mar 14, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

core-man Mar 14, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

core-man commented Mar 14, 2021

weiji14 left a comment

Choose a reason for hiding this comment

willschlitzer commented Mar 14, 2021 • edited Loading

weiji14 commented Mar 14, 2021

willschlitzer commented Mar 13, 2021 •

edited

Loading

weiji14 Mar 14, 2021 •

edited

Loading

weiji14 left a comment •

edited

Loading

core-man commented Mar 14, 2021 •

edited

Loading

core-man Mar 14, 2021 •

edited

Loading

willschlitzer commented Mar 14, 2021 •

edited

Loading