NCAR / wrf_hydro_nwm_public

WRF-Hydro model code
https://ral.ucar.edu/projects/wrf_hydro
Other
181 stars 139 forks source link

new feature: add repo citation file #717

Closed scrasmussen closed 9 months ago

scrasmussen commented 1 year ago

TYPE: new feature

KEYWORDS: citation, cff file

SOURCE: Soren Rasmussen, NCAR

DESCRIPTION OF CHANGES: Initial version of a CITATION.cff file, a Github repo citation file. Note that the first Zenodo identifier listed in the file is the one for all versions of WRF-Hydro and specific versions are listed below it. This helps solve the chicken-and-egg problem of creating a new Zenodo release but documentation pointing to the old version.

The authorship order is based on number of git commits, this can be manually changed in the file and we should discuss that order before merging. I believe that once the CITATION.cff file is added Zenodo will take it's authorship order from it for future releases. Here is an example screenshot of what the repo homepage will look like:

image

TESTS CONDUCTED: text only change.

Checklist

scrasmussen commented 1 year ago

@rcabell good idea about the ORCIDs! I'll try to track some down.

I put it as draft because I wanted to discuss the author order in a PR meeting before merging. Given the long history of the code maybe there are authors that should be listed that aren't, maybe a different order would be more appropriate?