lc-python-intro icon indicating copy to clipboard operation
lc-python-intro copied to clipboard

adding citation cff

Open jt14den opened this issue 1 year ago • 4 comments

Adding CITATION.cff, machine readable citation, see: https://carpentries.org/blog/2024/07/lesson-cffs/. I only added authors with content commits from last 12 month, so we could need to go further back.

We should also adjust what we add to the README and other places. See https://github.com/carpentries/lesson-development-training for how this integrates with GH.

jt14den avatar Sep 28 '24 21:09 jt14den

Thank you!

Thank you for your pull request :smiley:

:robot: 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:

  • :dart: correct output
  • :framed_picture: correct figures
  • :question: new warnings
  • :bangbang: new errors

Rendered Changes

:mag: Inspect the changes: https://github.com/LibraryCarpentry/lc-python-intro/compare/md-outputs..md-outputs-PR-137

The following changes were observed in the rendered markdown documents:


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.

:stopwatch: Updated at 2024-09-28 21:03:05 +0000

github-actions[bot] avatar Sep 28 '24 21:09 github-actions[bot]

Awesome, thanks for getting this moving @jt14den! I'm flagging @tobyhodges for input, since he helped me generate the readme citation from our official Zenodo release. That process also generated a Zenodo json file that includes the full list of past/present contributors. Guessing we'd want to leverage that to update a full .cff file?

chennesy avatar Oct 01 '24 19:10 chennesy

@chennesy thanks, I should have renamed the CITATION to CITATION.cff and included existing authors. This is what I'm started doing on other lessons I'm working on. See https://github.com/carpentries/lesson-development-training/blob/main/CITATION.cff. @tobyhodges, would be good to hear what you think.

jt14den avatar Oct 01 '24 21:10 jt14den

@tobyhodges can you give us some guidance on how this should work? I'm eager to implement in the LC

jt14den avatar Nov 02 '24 23:11 jt14den