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]

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

• 🎯 correct output
• 🖼️ correct figures
• ❓ new warnings
• ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/swcarpentry/git-novice/compare/md-outputs..md-outputs-PR-1021

The following changes were observed in the rendered markdown documents:

 12-citation.md | 13 +++++++++++--
 md5sum.txt     |  2 +-
 2 files changed, 12 insertions(+), 3 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-10-28 19:01:21 +0000

[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?

[martinosorb]

Suggested change

	Finally you may wish to include citation information in a [Citation File Format
	(`CITATION.cff`)](https://citation-file-format.github.io/) which are standardized human and machine readable citation
	information for software and datasets. If you host your repository on GitHub this information is automatically linked
	and rendered on the repository page and a BibTeX snippet is provided which users can copy and paste making it easy for
	your project to be cited. Further there is integration with both Zenodo and Zotero.
	Finally, you may wish to include citation information in a [Citation File Format
	(`CITATION.cff`)](https://citation-file-format.github.io/). CFF files are standardized human and machine readable citation
	information files for software and datasets. If you host your repository on GitHub, this information is automatically linked
	and rendered on the repository page and a BibTeX snippet is provided, which users can copy and paste, making it easy for
	your project to be cited. Further, integration with both Zenodo and Zotero is supported.

I added a few commas and tried to improve the flow.

[martinosorb]

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