Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changelog entry for v0.10.0 #2651

Merged
merged 25 commits into from
Sep 2, 2023
Merged

Changelog entry for v0.10.0 #2651

merged 25 commits into from
Sep 2, 2023

Conversation

weiji14
Copy link
Member

@weiji14 weiji14 commented Aug 31, 2023

Description of proposed changes

This PR adds the changelog entry for v0.10.0.

Preview at https://pygmt-dev--2651.org.readthedocs.build/en/2651/changes.html

Related to issue #2640

Previous release v0.9.0 at #2469

TODO

Fixes #

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 wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.
  • Use underscores (not hyphens) in names of Python files and directories.

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

@weiji14 weiji14 added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Aug 31, 2023
@weiji14 weiji14 self-assigned this Aug 31, 2023
@weiji14 weiji14 added this to the 0.10.0 milestone Aug 31, 2023
@weiji14 weiji14 mentioned this pull request Aug 31, 2023
35 tasks
CITATION.cff Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated
Comment on lines 9 to 11
* 🎉 **Tenth minor release of PyGMT** 🎉
*
* Two new tutorials and seven new gallery examples
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestions for highlights?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge the two entries in the "New Features" category and move it to "Highlights"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, have combined the two non-ASCII character PRs into one highlight at 81dfe9d. Any other ones, or this is good enough?

Copy link
Member

@yvonnefroehlich yvonnefroehlich Sep 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, a third highlight would be nice, but so far I don't have one 🙁. So, I am OK with two highlights.

doc/changes.md Outdated Show resolved Hide resolved
README.rst Outdated
@@ -180,7 +180,7 @@ Developers". Feel free to cite our work in your research using the following Bib

.. code-block::

@software{pygmt_2023_7772533,
@software{pygmt_2023_8303186,
author = {Uieda, Leonardo and
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we keep the same order list for the authors? Output of commits made on main branch at 1d8c0fd to first commit at e3c542a (git shortlog 1d8c0f...e3c542a -sne) shows this after I merge the same author names:

544  Dongdong Tian
255  Leonardo Uieda
216  Wei Ji
191  Will Schlitzer
169  dependabot[bot]
130  Yvonne Fröhlich
124  Michael Grund
109  Max Jones
 33  Yao Jiayuan
 15  Liam Toney
  7  yohaimagen
  4  Tong
  3  kmaterna
  2  Abhishek Anant
  2  Amanda Leaman
  2  Andre L. Belem
  2  Andrey Shmakov
  2  Claudio Satriano
  2  Conor Bacon
  2  Jamie J Quinn
  2  MichaeINeumann
  2  Noor Buchi
  2  Shivani chauhan
  2  Tyler Newton
  2  alperen-kilic
  2  carocamargo
  2  daroari
  2  obaney
  2  srijac
  1  Alicia Ngoc Diep Ha
  1  Andrés Ignacio Torres
  1  Becky Salvage
  1  Brook
  1  Cody Woodson
  1  Emily McMullan
  1  Jack Beagley
  1  Julius Busecke 
  1  Kadatatlu Kishore
  1  Loïc Houpert
  1  Malte Ziebarth
  1  Mark Wieczorek
  1  Philipp Loose
  1  Sean H
  1  Soham Banerjee
  1  Tawanda
  1  Vitor Gratiere Torres
  1  mdtanker
  1  shahid-0
  1  teriyakiSauce23

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on the counts of commits, I think we should at least make two changes:

  1. Move "Yvonne Fröhlich" before "Michael Grund"
  2. Move "Yao Jiayuan" before "Liam Toney"

As for the order between Leo and me, I'm not sure about this, considering that Leo created this package.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move "Yvonne Fröhlich" before "Michael Grund"

Ok with this. I've been meaning to ask @yvonnefroehlich if she would like to be a maintainer actually, she's been helping a lot with the documentation and doing a lot of good quality reviews lately.

Move "Yao Jiayuan" before "Liam Toney"

I don't think either of them have made a commit since 2021 (< v0.4.1), so not sure why we should change the order now... Liam did do quite a bit of work on the ROSES 2021 and 2020 videos, and I it was somewhat agreed at #1414 (comment) to keep the order this way?

As for the order between Leo and me, I'm not sure about this, considering that Leo created this package.

Leo said at #1594 (comment) that he was happy for you to go first, and I'd say you deserve it more now 🙂 But we can also leave it if you feel shy, and put your name first on the paper 😉

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move "Yvonne Fröhlich" before "Michael Grund"

Ok with this. I've been meaning to ask @yvonnefroehlich if she would like to be a maintainer actually, she's been helping a lot with the documentation and doing a lot of good quality reviews lately.

Yes, she's well qualified.

Move "Yao Jiayuan" before "Liam Toney"

I don't think either of them have made a commit since 2021 (< v0.4.1), so not sure why we should change the order now... Liam did do quite a bit of work on the ROSES 2021 and 2020 videos, and I it was somewhat agreed at #1414 (comment) to keep the order this way?

Sounds reasonable. Let's keep it unchanged.

As for the order between Leo and me, I'm not sure about this, considering that Leo created this package.

Leo said at #1594 (comment) that he was happy for you to go first, and I'd say you deserve it more now 🙂 But we can also leave it if you feel shy, and put your name first on the paper 😉

Aha, I didn't realize that. It's my honor to be listed as the first one. BTW, you're really good at digging history 😉

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, done at 852b025

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move "Yvonne Fröhlich" before "Michael Grund"

Ok with this. I've been meaning to ask @yvonnefroehlich if she would like to be a maintainer actually, she's been helping a lot with the documentation and doing a lot of good quality reviews lately.

Yes, she's well qualified.

First of all thanks a lot for this positive feedback, @weiji14 and @seisman 😊. I'm glad to hear this! I am really thankful for contributing to this project; I learned a lot. So, I would be pleased to become a maintainer of PyGMT. Hopefully the other @GenericMappingTools/pygmt-maintainers are also fine with this.
I feel I should have the time to help with the documentation and reviewing PRs in the future, but for more complicated code-related tasks I would need more (free) time, which is currently not very likely because of the workload of my PhD projects.

Just one comment regarding the commit list above: Looking at the commit numbers of the single contributors at https://github.com/GenericMappingTools/pygmt/graphs/contributors there is partly a significant difference to git shortlog 1d8c0f...e3c542a -sne (I can reproduce @weiji14 numbers). Looking at the total number of commits made so far to this repro, it seems that GitHub additionally includes / counts co-authorship?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Move "Yvonne Fröhlich" before "Michael Grund"

Ok with this. I've been meaning to ask @yvonnefroehlich if she would like to be a maintainer actually, she's been helping a lot with the documentation and doing a lot of good quality reviews lately.

Yes, she's well qualified.

First of all thanks a lot for this positive feedback, @weiji14 and @seisman 😊. I'm glad to hear this! I am really thankful for contributing to this project; I learned a lot. So, I would be pleased to become a maintainer of PyGMT. Hopefully the other @GenericMappingTools/pygmt-maintainers are also fine with this. I feel I should have the time to help with the documentation and reviewing PRs in the future, but for more complicated code-related tasks I would need more (free) time, which is currently not very likely because of the workload of my PhD projects.

No worries, feel free to help out as much (or as little) as you can, PhD comes first of course! If you can open up a PR to modify team.md, we can continue on from there.

Just one comment regarding the commit list above: Looking at the commit numbers of the single contributors at https://github.com/GenericMappingTools/pygmt/graphs/contributors there is partly a significant difference to git shortlog 1d8c0f...e3c542a -sne (I can reproduce @weiji14 numbers). Looking at the total number of commits made so far to this repro, it seems that GitHub additionally includes / counts co-authorship?

Yes, it might be that GitHub includes co-authored commits, whereas git log -sne only counts the main author.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No worries, feel free to help out as much (or as little) as you can, PhD comes first of course!

Sounds good 🙂!

If you can open up a PR to modify team.md, we can continue on from there.

Please see PR #2655.

doc/changes.md Outdated
Comment on lines 9 to 11
* 🎉 **Tenth minor release of PyGMT** 🎉
*
* Two new tutorials and seven new gallery examples
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merge the two entries in the "New Features" category and move it to "Highlights"?

doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
- given-names: Dongdong
family-names: Tian
affiliation: China University of Geosciences, China
orcid: https://orcid.org/0000-0001-7967-1197
- given-names: Leonardo
family-names: Uieda
affiliation: University of Liverpool, United Kingdom
Copy link
Member Author

@weiji14 weiji14 Sep 1, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Btw, we should remind @leouieda to update his affilliation - https://www.leouieda.com/blog/back-to-brazil.html. Let's do it after the release.

Co-authored-by: Michael Grund <[email protected]>
@weiji14 weiji14 marked this pull request as ready for review September 1, 2023 07:23
Copy link
Member

@michaelgrund michaelgrund left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

doc/changes.md Outdated Show resolved Hide resolved
@michaelgrund michaelgrund added the needs review This PR has higher priority and needs review. label Sep 1, 2023
Co-authored-by: Michael Grund <[email protected]>
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
Co-authored-by: Yvonne Fröhlich <[email protected]>
Copy link
Member Author

@weiji14 weiji14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pushing out the release date to 2nd Sep (following UTC time).

CITATION.cff Outdated Show resolved Hide resolved
doc/changes.md Outdated Show resolved Hide resolved
@weiji14 weiji14 added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Sep 1, 2023
@seisman
Copy link
Member

seisman commented Sep 2, 2023

Looks good to me, but do we want to move "Yvonne Fröhlich" as mentioned in #2651 (comment)

@weiji14
Copy link
Member Author

weiji14 commented Sep 2, 2023

Looks good to me, but do we want to move "Yvonne Fröhlich" as mentioned in #2651 (comment)

Oh yes, let me do that. Edit: done at b6100a3.

@weiji14
Copy link
Member Author

weiji14 commented Sep 2, 2023

Thanks everyone for the reviews! Let me merge this and tag the release before my next flight in one hour 😆

@weiji14 weiji14 merged commit e59b954 into main Sep 2, 2023
16 checks passed
@weiji14 weiji14 deleted the changelog/v0.10.0 branch September 2, 2023 01:15
@michaelgrund
Copy link
Member

Thanks everyone for the reviews! Let me merge this and tag the release before my next flight in one hour 😆

Great work! Thanks all for your efforts!

@yvonnefroehlich
Copy link
Member

Thanks everyone for the reviews! Let me merge this and tag the release before my next flight in one hour 😆

Great work! Thanks all for your efforts!

Thanks a lot @weiji14 for handling this release 🙂 and all other for their contributions to make this release possible 🎉!

@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Jan 14, 2024
@seisman seisman mentioned this pull request Jan 27, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants