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 new style citation file #9388

Merged
merged 1 commit into from Oct 7, 2021
Merged

Conversation

polm
Copy link
Contributor

@polm polm commented Oct 7, 2021

Description

This adds the new-style CITATION.cff file and places the older Bibtex formatted CITATION file.

Types of change

docs update

Checklist

  • I confirm that I have the right to submit this contribution under the project's MIT license.
  • I ran the tests, and all new and existing tests passed.
  • My changes don't require a change to the documentation, or if they do, I've added all required information.

@svlandeg svlandeg added the docs Documentation and website label Oct 7, 2021
@svlandeg
Copy link
Member

svlandeg commented Oct 7, 2021

This will need further updates later, but for now it's a good idea to use the new format at least :-)

@svlandeg svlandeg merged commit 48ba4e6 into explosion:master Oct 7, 2021
@sethidden
Copy link

sethidden commented Dec 20, 2021

Hmm I can't convert the .cff file to the bibtex fromat using https://github.com/citation-file-format/cff-converter-python
Is this a valid file?

$ pip3 install cffconvert
$ cffconvert --url https://raw.githubusercontent.com/explosion/spaCy/master/CITATION.cff -f bibtex
'https://raw.githubusercontent.com/explosion/spaCy/master/CITATION.cff' does not pass validation. Conversion aborted.

Same if I clone the repo and run in on the file, or curl just the file etc. I'm on Linux but I doubt it's some CRLF issue tbh
cc @polm please let me know if this looks valid and I'll create an issue

@polm
Copy link
Contributor Author

polm commented Dec 21, 2021

Github picks the file up just fine. Looking at the README for that project, is this the issue?

cffconvert does not support converting items from references or preferred-citation keys at the moment.

Our file uses preferred-citation because we refer to a paper and not the repo.

@adrianeboyd adrianeboyd mentioned this pull request Apr 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation and website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants