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

Add CITATION.cff file #1266

Closed
schnickalodeon opened this issue Jun 7, 2022 · 2 comments
Closed

Add CITATION.cff file #1266

schnickalodeon opened this issue Jun 7, 2022 · 2 comments

Comments

@schnickalodeon
Copy link

It would be nice, if you could add a CITATION.cff file to your repo. So other people can easyly cite your repo in their publications :)

@stakx
Copy link
Contributor

stakx commented Jun 7, 2022

Not being in academia myself, I don't see that much value in such a file (finding the project name, authors and repository URL and putting those together isn't exactly difficult to do after all), but if it's generally useful to people, then why not.

The one thing I as a project maintainer find to be a bit of a hassle is the inclusion of fields like version or date-released (or, even worse, commit); those would have to be kept up-to-date every time we do a release, so there's a wee little extra maintenance work (and I don't think it's worth automating upfront, even though that could be done e.g. with a custom GitHub Action).

I'd suggest we wait for some more reactions (upvotes, downvotes, further opinions) to this request.

@stakx
Copy link
Contributor

stakx commented Dec 12, 2022

Closing this issue due to inactivity.

@stakx stakx closed this as completed Dec 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants