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 software-specific citation file example #565

Open
wants to merge 1 commit into
base: gh-pages
from

Conversation

Projects
None yet
1 participant
@sdruskat

sdruskat commented Oct 11, 2018

Good practices for providing software citation metadata are moving beyond the provision of plain-text CITATION files (> machine-readability). The one commit in this PR contains more info. It adds a simple example for a CITATION.cff file for providing software citation metadata.

Add software-specific citation file (Citation File Format) to citatio…
…n episode

- Introduces including citation metadata specific to software, cf. the Software Citation Principles paper (https://peerj.com/articles/cs-86/) devised by the FORCE11 Software Citation Working Group
- This addition is minimal: the concept of including a CITATION file will have been touched upon in the remainder of the episode material, yet it adds relevant, up-to-date information that adheres to good practice
- Further information about the Citation File Format has been left out on purpose to keep the added information minimal, yet can easily be reached by learners via the link to the format website
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment