cct-datascience / group-procedures

Quarto book/wiki of group procedures and resources
https://cct-datascience.github.io/group-procedures/
Creative Commons Attribution 4.0 International
0 stars 0 forks source link

add CITATION.cff #50

Closed Aariq closed 7 months ago

Aariq commented 7 months ago

This draft PR adds a CITATION.cff file. This file gets used by GitHub to populate a little "Cite This Repository" button and is used by Zenodo to populate archive metadata. Please help by filling out your info in it including ORCID if you have one and affiliation. See Kristina's entry for an example of formatting. You do not need to include your email, as I think it makes sense to only include one.

Questions/comments:

Still TODO:

After this PR is merged, I'll link to Zenodo, make a release, and then add the new DOI to CITATION.cff and _quarto.yml

dlebauer commented 7 months ago

Thanks for doing this!

Aariq commented 7 months ago

Can't the type be 'manual'?

Not according to cffr::cff_validate() or the cffinit tool

I don't think it makes sense to keep the original order (me then alphabetical) and then switch to the order of joining the group; I like the idea of order of joining the group. I'd propose [Kristina, order of joining group, David].

Sounds great to me, but I don't know the order. Could you suggest a change in the PR?

plz add a comment to the CFF with the protocol + link to this PR

Good idea. I'll add a note to the message: field as well as a comment linking to this discussion.

dlebauer commented 7 months ago

proposed changes in #51

It appears cffr and ccfinit are correctly implemented based on the specification https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#type but inconsistent with the documentation; I'd suggest going w/ data and seeing what comes of https://github.com/orgs/community/discussions/110648

Aariq commented 7 months ago

type: manual is only valid for preferred-citation, not the main citation type where only software and data are allowed. don't think that preferred-citation is used for the primary citation metadata by Zenodo the way it is by GitHub. Not sure though.

Aariq commented 7 months ago

I'll check in with folks at standup and try to get this merged today or tomorrow and I'll open a follow-up issue for adding metadata to _quarto.yml