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

Guide Maintainers and Lesson Developers on Lesson Citation #197

Open
tobyhodges opened this issue May 7, 2024 · 3 comments
Open

Guide Maintainers and Lesson Developers on Lesson Citation #197

tobyhodges opened this issue May 7, 2024 · 3 comments
Assignees
Labels
transferred-issue Issues transferred from old handbook repo

Comments

@tobyhodges
Copy link
Member

Since CFF was adopted as the default for lesson citation (carpentries/sandpaper#583), we will need to provide Maintainers and lesson developers with advice on what information to include in their lessons' CITATION.cff files, and how to keep that information up-to-date. Ideas for what to include:

  1. lessons should use type: dataset in their CFF, not type: software
  2. do we make a recommendation of author list order, and criteria for inclusion in that list?
  3. when, and how often, should maintainers update the CFF?
  4. how should other lessons be referenced in the CFF, e.g. where a lesson is based on someone else's work? (This suggestion from @ocaisa based on Cross-referencing a .cff for the reference section citation-file-format/citation-file-format#538 (comment))
@tobyhodges tobyhodges self-assigned this May 7, 2024
@maneesha
Copy link
Collaborator

@tobyhodges Can we move this issue to the new handbook?

@maneesha
Copy link
Collaborator

maneesha commented Nov 7, 2024

@tobyhodges I am moving this to the new handbook.

@maneesha maneesha transferred this issue from carpentries/docs.carpentries.org Nov 7, 2024
@maneesha maneesha added the transferred-issue Issues transferred from old handbook repo label Nov 7, 2024
@tobyhodges
Copy link
Member Author

tobyhodges commented Nov 19, 2024

I propose to draft and include this after the handbook launch. We are still waiting for the next version of the CFF specification to be released before we can roll CITATION.cff files out across our official lessons. I want to handle that process centrally, to ensure consistency across our many lesson repositories. My concern is that including this in the handbook now might give Maintainers the impression that we want them to take care of it themselves.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
transferred-issue Issues transferred from old handbook repo
Projects
None yet
Development

No branches or pull requests

2 participants