-
Notifications
You must be signed in to change notification settings - Fork 5
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 citation file #1074
Add citation file #1074
Conversation
@joehcollins -- this is the citation file that I'm adding the repo. Please could you review and approve the PR? Once we have this is, we can make the repo public. |
Sorry tim just saw this - having a look now! |
Looks like checks are failing as "lists of files in version control and sdist do not match!" |
I don't really know what I'm doing here. But, I've made another change to the |
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 other than a few small bits. @tbhallett if you are happy for me to do so, I'll enable the Zenodo GitHub integration for the repository once it's been made public but before we create the 1.0.0 release as then we'll automatically get a DOI created for each new release (and also have the source code separately archived on Zenodo which is good from a long term availability perspective).
Unfortunately there is a bit of a chicken and egg situation with Zenodo / GitHub that we can't get a DOI until we create a release if using the automatic integration, so we can't include the DOI in the citation file until after we have tagged the release but that is a very minor issue!
Co-authored-by: Matt Graham <[email protected]>
Co-authored-by: Matt Graham <[email protected]>
Thanks. So, this is the order of business (to check I understand)
|
Yep that sounds all correct to me |
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.
A few more minor comments, but other than potential issue with MANIFEST which might cause check to fail, none of these are vital.
Co-authored-by: Matt Graham <[email protected]>
Co-authored-by: Matt Graham <[email protected]>
Co-authored-by: Matt Graham <[email protected]>
Adding file
CITATION.CFF
to root of repo as per https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files