https://deploy-preview-705--carpentries-website.netlify.app/blog/author/samantha-wittke/Recent content in Samantha Wittke on The CarpentriesHugoen-usMon, 18 Nov 2024 23:02:38 -0500https://deploy-preview-705--carpentries-website.netlify.app/blog/2024/07/lesson-cffs/Tue, 30 Jul 2024 00:00:00 +0000https://deploy-preview-705--carpentries-website.netlify.app/blog/2024/07/lesson-cffs/<p>In this post, co-authored by members of the CodeRefinery project and The Carpentries Curriculum Team, we discuss the current state and potential future applications of the Citation File Format (CFF) for open source lesson projects. The post concludes with a set of recommendations for what information should be captured in a <code>CITATION.cff</code> and how.</p> <h2 id="what-is-the-citation-file-format-cff">What is the Citation File Format (CFF)?</h2> <p>The <a href="https://citation-file-format.github.io/">Citation File Format</a> is a plain-text human- and machine readable citation information metadata for software and datasets. The text files contain standardized fields and use the <a href="https://en.wikipedia.org/wiki/YAML">YAML</a> serialization language. These fields are listed in a <code>CITATION.cff</code> text file, including but not limited to authors, title, version, identifiers, and type. Type is currently restricted to software and dataset. While lessons are neither software nor a dataset, the metadata collected in the CFF file represents well everything needed in order to also cite lesson materials.</p>