Skip to content

Commit

Permalink
Document that CITATION.cff needs to be updated every release
Browse files Browse the repository at this point in the history
  • Loading branch information
weiji14 committed Oct 28, 2021
1 parent 2677173 commit b12c568
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/release_checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
- [ ] Add the documentation link https://github.com/GenericMappingTools/pygmt#documentation-for-other-versions
- [ ] Add compatibility information https://github.com/GenericMappingTools/pygmt#compatibility-with-gmt-and-pythonnumpy-versions
- [ ] Copy draft changelog from Release Drafter and edit it to look nice ([see maintainers guide for details](https://www.pygmt.org/dev/maintenance.html#updating-the-changelog))
Expand Down
5 changes: 5 additions & 0 deletions AUTHORSHIP.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ there are a few options:
3. Indicate next to your name on `AUTHORS.md` that you do not wish to be
included with something like `(not included in Zenodo)`.

Note that authors included in the Zenodo archive will also have their name
listed in the `CITATION.cff` file. This is a machine (and human) readable file
that enables people to cite the PyGMT software easily, and the file will be
updated by the PyGMT maintainers each time a new release is made.

## Scientific publications (papers)

We aim to write academic papers for most of our software packages. Ideally, we
Expand Down
14 changes: 9 additions & 5 deletions doc/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -260,12 +260,16 @@ publishing the actual release notes at https://www.pygmt.org/latest/changes.html
7. Edit the list of people who contributed to the release, linking to their
GitHub account. Sort their names by the number of commits made since the
last release (e.g., use `git shortlog HEAD...v0.4.0 -sne`).
8. Update `README.rst` with new information on the new release version, namely
the BibTeX citation, a vX.Y.Z documentation link, and compatibility with
Python and GMT versions. Follow
8. Update `README.rst` with new information on the new release version,
including a vX.Y.Z documentation link, and compatibility with
GMT/Python/NumPyPython versions. Follow
[NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html#detailed-description)
for compatibility updates. Follow `AUTHORSHIP.md` guidelines for updating
the author list in the BibTeX citation.
for compatibility updates.
9. Refresh citation information. Specifically, the BibTeX in `README.rst` and
`CITATION.cff` needs to be updated with any metadata changes. Please follow
guidelines in `AUTHORSHIP.md` for updating the author list in the BibTeX.
More information about the `CITATION.cff` specication can be found at
https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md
### Check the README syntax
Expand Down

0 comments on commit b12c568

Please sign in to comment.