Skip to content

first draft of cff file - #59

Open
sstevens2 wants to merge 3 commits into
mainfrom
adding-cff
Open

first draft of cff file#59
sstevens2 wants to merge 3 commits into
mainfrom
adding-cff

Conversation

@sstevens2

Copy link
Copy Markdown
Collaborator

The latest update to the workbench makes it much easier to cite a lesson and it builds the citation from the cff file. I drafted a CFF including all the folks who have committed to the lesson since it was forked. Please review and add changes in line if you'd like your reference to be different. Thanks!

@gonuke @aronnem @kkiesling @pshriwise @ChristinaLK @qualiaMachine @maglet @taylor-scott

@github-actions

github-actions Bot commented Dec 29, 2025

Copy link
Copy Markdown

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/carpentries-incubator/swc-ext-python/compare/md-outputs..md-outputs-PR-59

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 2026-01-06 17:25:52 +0000

github-actions Bot pushed a commit that referenced this pull request Dec 29, 2025
@sstevens2

Copy link
Copy Markdown
Collaborator Author

Oh and would love it if you could add your orcid ids if possible! I couldn't find them all but added the ones I could find.

@pshriwise pshriwise left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks nice! Thank you for the notice @sstevens2.

@gonuke gonuke left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for starting this @sstevens2 - I've added some info in a PR suggestion

Comment thread CITATION.cff
@gonuke

gonuke commented Jan 3, 2026

Copy link
Copy Markdown
Contributor

Do you know if there is a way (or whether it makes sense?) to also have GitHub user names in the metadata? Maybe that's not relevant?

Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>
@sstevens2

Copy link
Copy Markdown
Collaborator Author

Do you know if there is a way (or whether it makes sense?) to also have GitHub user names in the metadata? Maybe that's not relevant?

@gonuke Good idea! From a quick look, I think maybe we could include a url for each author as well that links to their github page?

github-actions Bot pushed a commit that referenced this pull request Jan 5, 2026
@gonuke

gonuke commented Jan 5, 2026

Copy link
Copy Markdown
Contributor

Do you know if there is a way (or whether it makes sense?) to also have GitHub user names in the metadata? Maybe that's not relevant?

@gonuke Good idea! From a quick look, I think maybe we could include a url for each author as well that links to their github page?

Looking at the intent for this data, I'm not sure that including a reference to a github username/URL actually makes sense... but happy to add mine if you disagree

Comment thread CITATION.cff
@sstevens2

Copy link
Copy Markdown
Collaborator Author

Do you know if there is a way (or whether it makes sense?) to also have GitHub user names in the metadata? Maybe that's not relevant?

@gonuke Good idea! From a quick look, I think maybe we could include a url for each author as well that links to their github page?

Looking at the intent for this data, I'm not sure that including a reference to a github username/URL actually makes sense... but happy to add mine if you disagree

@gonuke I'm okay without adding usernames/urls as well. They should be able to find them with the repo url in the reference.

Comment thread CITATION.cff
github-actions Bot pushed a commit that referenced this pull request Jan 6, 2026
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.

4 participants