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.2.1 #683

Merged
merged 17 commits into from
Nov 14, 2020
Merged

Changelog entry for v0.2.1 #683

merged 17 commits into from
Nov 14, 2020

Conversation

seisman
Copy link
Member

@seisman seisman commented Nov 6, 2020

Description of proposed changes

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

For reference, the previous changelog is at #599.

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:

  • Highlights
  • New features
  • Enhancements
  • Documentation
  • Bug fixes
  • Maintenance
  • List of Contributors (sorted by number of commits)

TODO:

  • Format Pull Request links using sed -i.bak -E 's$\(#([0-9]*)\)$(`#\1 <https://github.com/GenericMappingTools/pygmt/pull/\1>`__)$g' changes.rst
  • 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.

Notes

  • You can write /format in the first line of a comment to lint the code automatically

@seisman seisman added maintenance Boring but important stuff for the core devs skip-changelog Skip adding Pull Request to changelog labels Nov 6, 2020
@seisman seisman added this to the 0.2.1 milestone Nov 6, 2020
@seisman
Copy link
Member Author

seisman commented Nov 6, 2020

@weiji14 I've drafted a changelog for v0.2.1 release. Please see if you want to make some changes.

doc/changes.rst Outdated Show resolved Hide resolved
doc/changes.rst Outdated Show resolved Hide resolved
* `Dongdong Tian <https://github.com/seisman>`__
* `Wei Ji Leong <https://github.com/weiji14>`__
* `Conor Bacon <https://github.com/hemmelig>`__
* `carocamargo <https://github.com/carocamargo>`__
Copy link
Member Author

Choose a reason for hiding this comment

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

@carocamargo Thanks again for your contribution to the PyGMT project. We're going to release PyGMT v0.2.1 soon. Please let us know if you want to use the github username or real name here.

Copy link
Member

Choose a reason for hiding this comment

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

Btw, If you want your name to be on the author list at Zenodo (https://zenodo.org/record/4025418), please also open up a Pull Request to add your name to https://github.com/GenericMappingTools/pygmt/edit/master/AUTHORS.md (and provide us with your ORCID and affiliation). Also cc @hemmelig on this.

doc/changes.rst Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <[email protected]>
@weiji14 weiji14 mentioned this pull request Nov 6, 2020
14 tasks
doc/changes.rst Show resolved Hide resolved
doc/changes.rst Show resolved Hide resolved
Copy link
Member

@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.

@seisman, I think we can go on and finish off this PR and cut a release. Could you run the sed command and handle these two tasks in this PR too?

doc/changes.rst Show resolved Hide resolved
doc/changes.rst Outdated
Tutorials & Gallery

* Add tutorial for pygmt.config (`#482 <https://github.com/GenericMappingTools/pygmt/pull/482>`__)
* Add an example for different line styles (#604, #664)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* Add an example for different line styles (#604, #664)
* Add an example for different line styles (`#604 <https://github.com/GenericMappingTools/pygmt/pull/604>`__, `#664 <https://github.com/GenericMappingTools/pygmt/pull/664>`__)

Copy link
Member Author

Choose a reason for hiding this comment

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

Nice catch. I believe it also means we should update our sed command.

doc/changes.rst Outdated Show resolved Hide resolved
@seisman seisman marked this pull request as ready for review November 14, 2020 07:22
doc/changes.rst Outdated Show resolved Hide resolved
Co-authored-by: Wei Ji <[email protected]>
@seisman seisman merged commit 2aa4aab into master Nov 14, 2020
@seisman seisman deleted the changelog/v0.2.1 branch November 14, 2020 07:47
@seisman
Copy link
Member Author

seisman commented Nov 14, 2020

FYI, I also updated the release draft information at https://github.com/GenericMappingTools/pygmt/releases/tag/untagged-835457ed8c763a4fb621.

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.

2 participants