swcarpentry
feature: Adds details on using CITATION.cff
Adds details on using Citation File Format as this is a human and machine readable format that integrates with GitHub, Zenodo and Zotero making it easier to share citation information and cite software.
Also includes a CITATION.cff file for the repository itself based on the existing CITATION information.
There appears to have been some discussion of this in the follow up comments of #712 but the issue was closed without adding details of CITATION.cff or such a file as this Pull Request does.
I didn't want to remove any content that is there although perhaps it might be worth considering replacing the plain CITATION example with CITATION.cff.
Check
Please do check that the information in CITATION.cff is correct, I think I've cited the correct license but wasn't sure.
Improvements
I had a cursory attempt to look up the ORCID of each of the listed authors but couldn't work it out so have left these out. They can be added under each author in the following manner...
authors:
- given-names: Ivan
family-names: Gonzalez
orcid: 'https://orcid.org/0000-0000-0000-0000'
Hope this is useful, and please let me know if there is anything I can do to improve the content.
@ns-rse
:ok: Pre-flight checks passed :smiley:
This pull request has been checked and contains no modified workflow files, spoofing, or invalid commits.
It should be safe to Approve and Run the workflows that need maintainer approval.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
Sure, not a problem @tobyhodges CITATION.cff removed and added the Turing Way suggestion.
I'm thinking of merging this as soon as we have an example of CFF either in the episode or as a separate file for the whole lesson. However, this gave me the opportunity to reread this episode and I believe it should be somewhat rewritten. I have opened an issue about this (#1063) and any opinions on what this episode should look like in general are encouraged. Thanks!
