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

Adding a CITATION.cff file #12

Open
2 of 3 tasks
apmoore1 opened this issue Dec 8, 2021 · 0 comments
Open
2 of 3 tasks

Adding a CITATION.cff file #12

apmoore1 opened this issue Dec 8, 2021 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation low priority Low priority issue

Comments

@apmoore1
Copy link
Member

apmoore1 commented Dec 8, 2021

Add a CITATION.cff file so that users can cite the software, the Turing way book has a great guide on how to do this. As we may create a paper based around this software in the future I have had a look at how to use the cff file format to ask users to cite both the software and the potential future paper describing the software, of which the answer to this can be found in the CITATION.cff schema guide.

Linked to this would be to create a DOI for the software using Zenodo, a guide on how to do this can be found in this section of the Turing Way book

Checklist of issues to resolve in this issue:

  • Add a CITATION.cff file.
  • Add a validation step to check the CITATION.cff conforms to the CFF schema within the GitHub CI workflow
  • Link the repository with Zenodo to create a DOI.
@apmoore1 apmoore1 added the low priority Low priority issue label Dec 8, 2021
@apmoore1 apmoore1 mentioned this issue Dec 9, 2021
@apmoore1 apmoore1 added the documentation Improvements or additions to documentation label Dec 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation low priority Low priority issue
Projects
None yet
Development

No branches or pull requests

2 participants