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 initial CITATION.cff #487
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, but I think the authors should include all contributors, not just me. Is there a standard practice for software citations?
Discussion:Here are some thoughts. Let me know if any of these seem like a good approach and I'll update this pull-request accordingly.
It looks like this: authors:
- family-names: Abadi
given-names: Martín
- family-names: Agarwal
given-names: Ashish
- family-names: Barham
given-names: Paul
... Lasio has 17 code contributors so they can be added as authors to the citation. Let me know if this is the preferred approach and I'll update this pull-request. Note, there are some folks have made contributions by creating issues or commenting on issues, it would be prohibitively manual to maintain a list of these contributors.
authors:
- name: "The Research Software Project"
website: "https://research-software-project.org" We might modify that to use the url that lists the contributors in addition to an individual. Is this an acceptable approach? authors:
- family-names: Inverarity
given-names: Kent
orcid: https://orcid.org/0000-0002-5902-2007
- name: "Lasio contributors"
website: "https://lasio.readthedocs.io/en/latest/contributing.html" |
Update: I used the Lasio documentation link to the contributors rather than the GitHub url to contributors, https://github.com/kinverarity1/lasio/graphs/contributors, but both seem like reasonable options. Let me know if the GitHub link is preferred and I'll make the change. -- Thank you, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great! Thank you!
Description:
This pull-request is for Issue #486 "Adding a citation file, and maybe a DOI".
This change adds an initial CITATION.cff file. However, I didn't find a DOI so the file does not include a DOI.
If a DOI is created in the future it can be added to the CITATION.cff at that time.
--
Let me know if this change could be accepted (or rejected) or
needs some additional changes to be approved and merged.
Thank you,
DC