Citation Information for Open Source Lessons

Tue, 30 Jul 2024 00:00:00 +0000

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 CITATION.cff and how.

What is the Citation File Format (CFF)?

The Citation File Format is a plain-text human- and machine readable citation information metadata for software and datasets. The text files contain standardized fields and use the YAML serialization language. These fields are listed in a CITATION.cff 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.

Lessons Learned from Running Code Refinery's First Online Workshop

Mon, 20 Apr 2020 00:00:00 +0000

This blog post was originally posted on the CodeRefinery website. In the CodeRefinery project we teach research software engineering tools and workflows, using the Carpentries style.

April 7-8, 2020, we gave our first online workshop on introduction to Git (2 x 3 hours) with 22 participants and we plan to deliver many more such workshops on a number of topics based on our lessons.

The workshop went well. Online feels slower, but has a different set of advantages (we discussed later whether we actually covered significantly less than during an in-person workshop and we were not sure the pace was actually slower).

Radovan Bast on The Carpentries

Citation Information for Open Source Lessons

What is the Citation File Format (CFF)?

Lessons Learned from Running Code Refinery's First Online Workshop