Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding citation cff #137

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

adding citation cff #137

wants to merge 1 commit into from

Conversation

jt14den
Copy link
Member

@jt14den jt14den commented Sep 28, 2024

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.

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.
@jt14den jt14den requested a review from chennesy September 28, 2024 21:02
Copy link

github-actions bot commented Sep 28, 2024

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/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.

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

github-actions bot pushed a commit that referenced this pull request Sep 28, 2024
@chennesy
Copy link
Contributor

chennesy commented Oct 1, 2024

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?

@jt14den
Copy link
Member Author

jt14den commented Oct 1, 2024

@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
Copy link
Member Author

jt14den commented Nov 2, 2024

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

@jt14den jt14den requested a review from tobyhodges November 2, 2024 23:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants