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 CITATION.cff #71

Merged
merged 5 commits into from
Sep 1, 2021
Merged

Add CITATION.cff #71

merged 5 commits into from
Sep 1, 2021

Conversation

simleo
Copy link
Collaborator

@simleo simleo commented Jul 28, 2021

Adds CITATION.cff to the repo. This is now supported by GitHub.

All should review this, especially to check if I got the ORCIDs right.

At some point we should review and single-source all this information. This file looks like the best source for authors, since it contains more information and it's structured; OTOH, the release date should probably be generated upon tagging.

@stain
Copy link
Contributor

stain commented Jul 28, 2021

+1 Checked all ORCIDs match listing on https://www.researchobject.org/ro-crate/community.html except @albangaignard which anyway match http://albangaignard.github.io/about/

The DOI is the 0.4.0 release, meaning we would have to update it on each release - and it would be off-by-one within each release as the DOI is made automatically afterwards. Should we change to the version-less DOI https://doi.org/10.5281/zenodo.3956493 so we don't have to change it? Or as we have to update version anyway before a release, just bite the bullet that the DOI will be wrong at tagging time?

I note that for instance cff-converter-python uses the version-less DOI.

BTW - is the CITATION.cff accessible from pip? We could add it somehow in setup.py so that this is accessible also outside github?

@simleo
Copy link
Collaborator Author

simleo commented Jul 28, 2021

The DOI is the 0.4.0 release, meaning we would have to update it on each release - and it would be off-by-one within each release as the DOI is made automatically afterwards. Should we change to the version-less DOI https://doi.org/10.5281/zenodo.3956493 so we don't have to change it? Or as we have to update version anyway before a release, just bite the bullet that the DOI will be wrong at tagging time?

Changed to the versionless DOI. Seems more appropriate for something that's supported by a repository widget, since it reflects the ongoing development version. For instance, we still had to add @ilveroluca to the authors and now I added him in 84cd65c, however he wasn't an author as of release 0.4.0.

BTW - is the CITATION.cff accessible from pip? We could add it somehow in setup.py so that this is accessible also outside github?

Added CITATION.cff, and LICENSE which was missing, to MANIFEST.in.

@simleo simleo merged commit 44e730c into master Sep 1, 2021
@simleo simleo deleted the add_cff branch September 1, 2021 08:01
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