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

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

Add software-specific citation file example #565

wants to merge 1 commit into from

Conversation

@sdruskat
Copy link
Contributor

@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.

…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
@katrinleinweber
Copy link
Contributor

@katrinleinweber katrinleinweber commented Dec 17, 2018

Hi Stephan! I'm not a maintainer here, but because this is adding a new concept/tool: What would you suggest be removed from the lesson to make room for this?

@munkm
Copy link
Member

@munkm munkm commented Jan 23, 2019

Hi @sdruskat! Thank you for your pull request. Making sure learners know about ways that software citation is handled is a great concept and I think could be really good for learners to find out about. How would you feel about modifying this to be an exercise? You could have the exercise explanation be the text you've proposed here as an "example", and then further have learners could find an example of a .cff file in a software project on github that they use in their workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants