Skip to content

add citation file CITATION.cff #355

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

Merged
merged 6 commits into from
Mar 24, 2023
Merged

add citation file CITATION.cff #355

merged 6 commits into from
Mar 24, 2023

Conversation

millecodex
Copy link
Contributor

I am citing this repo for my thesis and thought a citation file could help others. I've made some assumptions with the authors; obviously it can be modified accordingly. Cheers.

It cites APA:
Arya, A., Brown, C., Pike, R., & The Open Source Security Foundation. (2020). Open Source Project Criticality Score (Version 2.0.2) [Computer software]. https://github.com/ossf/criticality_score

And bibtex:

@software{Arya_Open_Source_Project_2020,
author = {Arya, Abhishek and Brown, Caleb and Pike, Rob and {The Open Source Security Foundation}},
license = {Apache-2.0},
month = {12},
title = {{Open Source Project Criticality Score}},
url = {https://github.com/ossf/criticality_score},
version = {2.0.2},
year = {2020}
}

cff repo https://github.com/citation-file-format/citation-file-format
website: https://citation-file-format.github.io/

Signed-off-by: Mille Codex <[email protected]>
Signed-off-by: Mille Codex <[email protected]>
Signed-off-by: Mille Codex <[email protected]>
unsure how to include "The Open Source Security Foundation", if at all.


Signed-off-by: Mille Codex <[email protected]>
CITATION.cff Outdated
given-names: "Rob"
- name: "The Open Source Security Foundation"
title: "Open Source Project Criticality Score"
date-released: 2020-12-09
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not that familiar with cff - should this be the first release date, or the date that corresponds to the release of the version specified below (i.e. 2.0.2).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ya, I had the same question. After a bit more digging it looks like best practice is to use release date (similar to using 5th edition of a book). There some background info here: https://www.software.ac.uk/how-cite-software.

I updated the date to match.

@calebbrown calebbrown merged commit 1818e69 into ossf:main Mar 24, 2023
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.

2 participants