Skip to content

adding Citation files to cookiecutter-data-science template - #274

Closed
kjgarza wants to merge 1 commit into
drivendataorg:masterfrom
kjgarza:citation-cff
Closed

adding Citation files to cookiecutter-data-science template#274
kjgarza wants to merge 1 commit into
drivendataorg:masterfrom
kjgarza:citation-cff

Conversation

@kjgarza

@kjgarza kjgarza commented Jul 24, 2022

Copy link
Copy Markdown

CITATION.cff files are plain text files with human- and machine-readable citation information for software (and datasets). Code developers can include them in their repositories to let others know how to correctly cite their software.

It is very easy to correctly cite a paper: all the necessary information (metadata) can be found on the title page or the article website. Software and datasets have no title page, the relevant information is often less obvious.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

CITATION.cff files are plain text files with human- and machine-readable citation information for software (and datasets). Code developers can include them in their repositories to let others know how to correctly cite their software.

It is very easy to correctly cite a paper: all the necessary information (metadata) can be found on the title page or the article website. Software and datasets have no title page, the relevant information is often less obvious.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files
@kjgarza

kjgarza commented Jul 27, 2022

Copy link
Copy Markdown
Author

Hi @pjbull, I was just wondering if someone had a chance to discuss this PR? thanks

@pjbull

pjbull commented Jul 31, 2022

Copy link
Copy Markdown
Member

@kjgarza I think we'd consider this during the transition to v2, but to me it doesn't seem super likely given that only a small fraction of data science projects will have an associated citation. Could you file an issue instead and link to your branch in your fork?

@kjgarza

kjgarza commented Aug 21, 2022

Copy link
Copy Markdown
Author

done in #278

@xaucerr

xaucerr commented Aug 21, 2022

Copy link
Copy Markdown

Great work @kjgarza.

Actually, some would argue that including the CFF file as part of data science or research templates is fundamental as it might nudge users into the desired behaviour. Shout-out to @hainesr @danielskatz @npch, maybe they can provide more context here.

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.

3 participants