Skip to content

Update AUTHORS and CITATION #341

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

Open
K-Meech opened this issue Mar 28, 2025 · 2 comments
Open

Update AUTHORS and CITATION #341

K-Meech opened this issue Mar 28, 2025 · 2 comments
Labels
status:wait Progress dependent on another issue or conversation

Comments

@K-Meech
Copy link
Contributor

K-Meech commented Mar 28, 2025

How could the content be improved?

We currently have an AUTHORS and CITATION file that are quite out of date e.g.:

  • AUTHORS only lists one author
  • CITATION contains a placeholder: 'Image Processing workshop citation'

We should probably replace these with an updated CITATION.cff file, which seems to be the preferred way of storing this info now. For example, see the CITATION.cff for the carpentries lesson development training

Which part of the content does your suggestion apply to?

AUTHORS file + CITATION file

@tobyhodges
Copy link
Member

You are right that CITATION.cff is the better format for this information, @K-Meech. However, I would really like to take a consistent approach to these citation files across all of The Carpentries official lessons. This needs a coordinated effort across all of our repositories, which the Curriculum Team should lead. I hope to be able to do this later in 2025, when I hope we will have also introduced a Cite This Lesson page, built from the info in the CFF file, into Workbench lesson sites.

So I humbly request that Maintainers hold off on this for now, since any CFF you put together now will be in danger of getting clobbered by a version we roll out later. ❤

@K-Meech K-Meech added the status:wait Progress dependent on another issue or conversation label Mar 28, 2025
@K-Meech
Copy link
Contributor Author

K-Meech commented Mar 28, 2025

Thanks for the info @tobyhodges ! Makes sense - I've added the status:wait label to make it clear this is on hold for now 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:wait Progress dependent on another issue or conversation
Projects
None yet
Development

No branches or pull requests

2 participants