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.

Sign up for GitHub

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

Jump to bottom

Task: Make this repository citeable #330

Closed
2 tasks done
Tracked by #246
matt-graham opened this issue Mar 25, 2024 · 8 comments
Closed
2 tasks done
Tracked by #246

Task: Make this repository citeable #330

matt-graham opened this issue Mar 25, 2024 · 8 comments
Assignees
@samcunliffe @matt-graham @paddyroddy
Labels
task A task to be completed with the repo

Comments

@matt-graham
Copy link
Collaborator

matt-graham commented Mar 25, 2024 •
edited

What needs to be done?

We should add a CITATION.cff file to make it clear how to cite this repository itself, particularly as we're starting to think about advertising more widely. Relatedly we may also want to set up the Zenodo integration for the repository if we haven't already done so we get DOIs when we make a release.

Tasks
Beta Give feedback
@matt-graham matt-graham added the task A task to be completed with the repo label Mar 25, 2024
@paddyroddy
Copy link
Member

I had wondered about this recently 🤔 prompted by the Code for Thought podcast recently

@matt-graham
Copy link
Collaborator Author

Now that GitHub allows linking ORCIDs to profiles it feels like there should be a way to automate keeping the author list on a CITATION.cff up to date (assuming this is based on contributor list, potentially with some filtering) 🤔

@paddyroddy
Copy link
Member

I'm still a bit confused what the ORCiD bit is doing in CITATION.cff. Like it doesn't appear in the output Roddy, P. J. (2023). SLEPLET: Slepian Scale-Discretised Wavelets in Python. Journal of Open Source Software, 8(84), 5221. https://doi.org/10.21105/joss.05221
image

@matt-graham
Copy link
Collaborator Author

The Zenodo integration automatically picks up ORCIDs from the CITATION.cff file I think for example (e.g. https://zenodo.org/records/10144016). I think the purpose of the file is more general than the GitHub usage.

@paddyroddy
Copy link
Member

Maybe you're right. I know mine has picked up the ORCiD here doi.org/10.5281/zenodo.7268074, but that could have easily been from my Zenodo account (like I wouldn't need CITATION.cff to achieve the same). But maybe for co-authors it is necessary...

@paddyroddy
Copy link
Member

Related zenodo/zenodo#596

@samcunliffe
Copy link
Member

I guess we want a DOI for the pages too?

@matt-graham matt-graham changed the title Task: Add a CITATION.cff file Task: Add a CITATION.cff file for this repository Mar 25, 2024
@matt-graham matt-graham changed the title Task: Add a CITATION.cff file for this repository Task: Make this repository citeable Mar 26, 2024
@matt-graham matt-graham mentioned this issue Mar 26, 2024
Merged
@samcunliffe samcunliffe mentioned this issue Mar 27, 2024
Open
10 tasks
matt-graham added a commit that referenced this issue Apr 29, 2024
@matt-graham @paddyroddy
Add CITATION.cff file (#340)
3d34928 
Part of #330 

Adds a CITATION.cff file for this repository with all current
contributors included as authors.
The ordering of authors should match the non-bot accounts on
https://github.com/UCL-ARC/python-tooling/graphs/contributors

I have added ORCIDs for everyone I could find them for either from
GitHub profile or ARC people directory. Similarly I have tried to enter
given and family names as listed on GitHub Profile or ARC people
directory but add a review comment if I've made any mistakes or you
would prefer to be listed differently.

I am requesting a review from everyone who is listed as an author. If
you are happy to be included as an author and don't want any changes
made to your information please approve. If you need any changes made to
your information or want to be removed as an author please add a review
and request changes accordingly.

As I ran out of reviewer slots (maximum of 15 😅) I'm manually tagging
@paddyroddy and @samcunliffe

---------

Co-authored-by: Patrick J. Roddy <[email protected]>
@matt-graham
Copy link
Collaborator Author

I've created a separate issue for the remain task (#411) but I think the main points here have been resolved by #340 so closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@samcunliffe samcunliffe

@matt-graham matt-graham

@paddyroddy paddyroddy

Labels
task A task to be completed with the repo
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@samcunliffe @matt-graham @paddyroddy