-
Notifications
You must be signed in to change notification settings - Fork 220
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.13.0 #3425
Conversation
9383f41
to
2c8eb47
Compare
doc/changes.md
Outdated
|
||
### Enhancements | ||
|
||
* pygmt.x2sys_cross: Refactor to use virtualfiles for output tables [BREAKING CHANGE: Dummy times in 3rd and 4th columns now have np.timedelta64 type] ([#3182](https://github.com/GenericMappingTools/pygmt/pull/3182)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps we should add a separate category for breaking changes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would make those changes more / directly visible to users!
Meaning we have to define a new label "breaking changes" and add it to
pygmt/.github/release-drafter.yml
Lines 8 to 20 in 6dc8eb0
categories: | |
- title: 'New Features' | |
label: 'feature' | |
- title: 'Enhancements' | |
label: 'enhancement' | |
- title: 'Deprecations' | |
label: 'deprecation' | |
- title: 'Bug Fixes' | |
label: 'bug' | |
- title: 'Documentation' | |
label: 'documentation' | |
- title: 'Maintenance' | |
label: 'maintenance' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Common changelog uses a prefix like **Breaking**
or **<subsystem> (breaking):**
for highlighting breaking changes, see https://github.com/vweevers/common-changelog?tab=readme-ov-file#244-prefixes. Maybe we could follow that instead of adding a new label/section?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good. Changes in 7d3ac63.
family-names: Wessel | ||
affiliation: University of Hawaiʻi at Mānoa, USA | ||
orcid: https://orcid.org/0000-0001-5708-7336 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Didn't want to bring this up so soon, but since Paul passed away, I'm wondering what the convention was in keeping his name on the citation list? Do we remove his name now, keep his name on for a couple more releases, or remove it after his funding/grants run out? See e.g. https://academia.stackexchange.com/questions/116845/dead-author-ethical-guidelines
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personally, I prefer to keep Paul's name at least in the period of the funding.
The link you provided only discussed the topic for journal articles, but here it's software and may be slightly different.
Anyway, we should keep this in mind and may need to revisit it later.
Edit: Probably should ask for comments from the GMT steering community. Will do it later.
Co-authored-by: Yvonne Fröhlich <[email protected]>
This PR is ready for final review. I plan to merge this PR and make the release in 12 hours (before midnight for UTC+8 time zone). |
Co-authored-by: Wei Ji <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! Wait for second approval before merge.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
Co-authored-by: Michael Grund <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good for me!
Co-authored-by: Yvonne Fröhlich <[email protected]>
Co-authored-by: Michael Grund <[email protected]>
Description of proposed changes
This PR adds the changelog entry for v0.13.0.
Checklist
doc/_static/version_switch.js
for documentation switcherdoc/minversions.md
CITATION.cff
and BibTeX at https://github.com/GenericMappingTools/pygmt#citing-pygmtdoc/changes.md
doc/changes.md
git shortlog HEAD...v0.1.2 -sne
)