Add CITATION.cff file for PyGMT #1592
Conversation
Human- and machine-readable citation information for software. Generated using `doi2cff` and modified slightly to cff 1.2.0 schema, see https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md for details.
| date-released: 2021-08-07 | ||
| doi: 10.5281/zenodo.5162003 | ||
| license: BSD-3-Clause | ||
| repository-code: https://github.com/GenericMappingTools/pygmt | ||
| type: software | ||
| version: 0.4.1 |
There was a problem hiding this comment.
I can modify this to use the v0.5.0 DOI and date if that's preferable.
There was a problem hiding this comment.
Please do update it for tomorrow's release
There was a problem hiding this comment.
On second thought, maybe better to change it in the PyGMT v0.5.0 changelog PR. Here's the diff for reference.
| date-released: 2021-08-07 | |
| doi: 10.5281/zenodo.5162003 | |
| license: BSD-3-Clause | |
| repository-code: https://github.com/GenericMappingTools/pygmt | |
| type: software | |
| version: 0.4.1 | |
| date-released: 2021-10-29 | |
| doi: 10.5281/zenodo.5607255 | |
| license: BSD-3-Clause | |
| repository-code: https://github.com/GenericMappingTools/pygmt | |
| type: software | |
| version: 0.5.0 |
There was a problem hiding this comment.
On second thought, maybe better to change it in the PyGMT v0.5.0 changelog PR.
I agree.
|
Thanks, @weiji14! Will this need to be manually updated for each release? If so, could you please add this to the release checklists in the GitHub template and maintenance guide? |
| @@ -20,7 +20,7 @@ assignees: '' | |||
| - [ ] Reserve a DOI on [Zenodo](https://zenodo.org) by clicking on "New Version" | |||
| - [ ] Finish up 'Changelog entry for v0.x.x' Pull Request: | |||
| - [ ] Add a new entry in `doc/_static/version_switch.js` for documentation switcher | |||
| - [ ] Update citation information https://github.com/GenericMappingTools/pygmt#citing-pygmt | |||
| - [ ] Update `CITATION.cff` and BibTeX at https://github.com/GenericMappingTools/pygmt#citing-pygmt | |||
There was a problem hiding this comment.
Do we really want to maintain the citation information at these two places? The 'Cite this repository' button can already generate the BibTeX information.
There was a problem hiding this comment.
Yes? I don't like the formatting from the Export to BibTeX, it doesn't wrap the authors list. Also, I think it's good to have the BibTeX on PyPI. But maybe get a second opinion on this.
There was a problem hiding this comment.
I'm not familiar with the pros and cons of using CITATION.cff instead of BibTeX information, but I think we should err on the side of providing users with more options. I think that releases are few and far between, so adding a few extra parameters to update won't be that much of a demand for maintainers.
seisman
added
the
final review call
seisman
removed
the
final review call
Human- and machine-readable citation information for software. Generated using `doi2cff` and modified slightly to cff 1.2.0 schema, see https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md for details. * Document that CITATION.cff needs to be updated every release Co-authored-by: Will Schlitzer <schlitzer90@gmail.com> Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Description of proposed changes
Human- and machine-readable citation information for software! Generated using
doi2cffand modified slightly to cff 1.2.0 schema, see https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md for details.Preview the 'Cite this repository' button at https://github.com/GenericMappingTools/pygmt/tree/citation-cff
You can validate that the
CITATION.cffhas the correct schema following https://github.com/citation-file-format/cff-converter-python/tree/2.0.0#validating-a-remote-citationcff-file, e.g. with this command:Fixes #1403
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version