feature: Adds details on using CITATION.cff

[ns-rse]

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

[github-actions]

🆗 Pre-flight checks passed 😃

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.

[tobyhodges]

Thanks @ns-rse. We also had some discussion of this in #1006, where @malvikasharan suggested that we link to the relevant section of The Turing Way. I have suggested an additional sentence that would link out to that resource.

I request that the Maintainers do not include the CFF for the lesson repository for now. I will be working on rolling out CFFs consistently across all DC, LC and SWC lessons next year (part of a larger effort to integrate them further into the lesson infrastructure) and would prefer not to confuse things by adding one here in the meantime. One reason is that I would like the author list to mention everyone who has made a conrtibution to the lesson.

@ns-rse if you are happy to do so, please remove the CFF from this PR.

[ns-rse]

Sure, not a problem @tobyhodges CITATION.cff removed and added the Turing Way suggestion.

[tobyhodges]

Thanks @ns-rse 🙌

[martinosorb]

I find this a little vague. "you may wish" why exactly? What is the difference compared to CITATION.txt?

[ns-rse]

Sorry for not getting back sooner.

CFF is a YAML format with defined fields which makes them machine readable. Whilst possible to stick CITATION in to any repository it doesn't conform to this standard and makes it harder to then parse and collate such information across published software.

GitHub has CFF integration and it makes links available to export the citation in different formats.

[martinosorb]

I like how you explained it to me in this comment, it's more explicit and pedagogical than the description in the lesson. However, I think this whole episode should be reorganized a bit, so it's ok for now.

[martinosorb]

If the format is very different, should we provide an example of a cff file as well?

[ns-rse]

Could perhaps update this repositories CITATION to the CFF format to serve as an example and link to it. Perhaps address as a separate issue?

[martinosorb]

Yes, if you could make a cff for this lesson it would be great please.

[martinosorb]

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!