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

Issue182 citation #190

Merged
merged 3 commits into from Oct 10, 2018

Conversation

Projects
None yet
2 participants
@jspaaks
Contributor

jspaaks commented Oct 10, 2018

Hello recipiers,
I've taken the liberty of adding some citation data to your repo in this PR. I'm using the rather new CITATION.cff file format (basically, a machine-readable version of CITATION files; more info here https://citation-file-format.github.io/). I then used the CITATION.cff file to create another file, .zenodo.json which can be used to tell Zenodo (a DOI-issuing and archiving service, https://zenodo.org/) what metadata you want to associate with releases that you make using the GitHub-Zenodo integration (more info about that here https://guides.github.com/activities/citable-code/).

The whole process is documented in our guide https://guide.esciencecenter.nl/citable_software/making_software_citable.html

Here is an example of a repository that uses CITATION.cff and .zenodo.json files:

https://github.com/NLeSC/Xenon

Here is what that looks like on Zenodo:

https://zenodo.org/record/1287235

And here is an example of what you can do with machine readable citation data (specifically, the 'Cite this software' block)

https://www.research-software.nl/software/xenon

Hope you like it.

Best regards,
-Jurriaan

PS final note: don't forget to update the date-released and version keys in CITATION.cff, right before making a release. I've assigned placeholder values for the time being.

@robintw robintw merged commit 9043492 into recipy:master Oct 10, 2018

1 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build failed
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
@robintw

This comment has been minimized.

Show comment
Hide comment
@robintw

robintw Oct 10, 2018

Contributor

Thanks for the contribution Jurriaan!

Contributor

robintw commented Oct 10, 2018

Thanks for the contribution Jurriaan!

@jspaaks

This comment has been minimized.

Show comment
Hide comment
@jspaaks

jspaaks Oct 11, 2018

Contributor

No problem, glad I could be part of it :)

Contributor

jspaaks commented Oct 11, 2018

No problem, glad I could be part of it :)

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