Formalise citation info

[katrinleinweber]

Because this was asked in #272, #1198 & #1555, here's a suggestion to include spaCy's citation metadata according to the Software Sustainability Institute.

Additional formalisation (and a code backup at CERN 😉) is possible through GitHub's "Citable Code" guide. From there, a BibTeX snippet can be auto-imported to people's reference manager, with DOI and URL to a persistent, versioned landing page as recommended by the Software Citation Principles.

I volunteer to update the BibTeX snippet here accordingly if you use Zenodo. And in the future, if you ping me when the paper is out.

Description

Adding the BibTeX snippet as an upper-case file to the code-base.

Types of change

Docu expansion

Checklist

• I have submitted the spaCy Contributor Agreement.
• I ran the tests, and all new and existing tests passed. Adding two text files through GitHub's web UI
• My changes don't require a change to the documentation, or if they do, I've added all required information.

[explosion-bot]

Hi @katrinleinweber, thanks for your pull request! 👍 It looks like you haven't filled in the spaCy Contributor Agreement (SCA) yet. The agrement ensures that we can use your contribution across the project. Once you've filled in the template, put it in the .github/contributors directory and add it to this pull request. If your pull request targets a branch that's not master, for example develop, make sure to submit the Contributor Agreement to the master branch. Thanks a lot!

If you've already included the Contributor Agreement in your pull request above, you can ignore this message.

[katrinleinweber]

Doesn't the bot check the files included in a PR? Ah, it does, and it's very accurate about the file extension :-D

[honnibal]

Thanks a lot for this! I've lost track of the correct academic incantations these days. The citeable code guide looks like a very neat solution.

Hopefully we can make this actually appear soon...

[katrinleinweber]

You're welcome, and thanks for merging :-) Good luck with the paper submission.

[ines]

@katrinleinweber Thanks for the PR and the suggestion – just signed us up for Zenodo and will check back once we've published the next release to make sure it all worked as expected 👍

[rpgoldman]

@katrinleinweber Two things about the citation:

1. I think you need to protect the title from LaTeX re-capitalizing it, like so: {{spaCy 2}: Natural language understanding with Bloom embeddings, convolutional neural networks and incremental parsing}

2. Was this paper ever published? It's marked as submitted, dating from 2017 -- anyone know if it's accepted?

[katrinleinweber]

The PR base would be https://github.com/explosion/spaCy/edit/master/CITATION ;-)

[rpgoldman]

@katrinleinweber I'm sorry, but honestly, the overhead of forking and submitting a PR is just too much for a simple one-liner like this. I will download the CITATION, tweak it, and supply a patch file, ok?

[rpgoldman]

@katrinleinweber
Here's the patch file.
CITATION.patch.txt

If you strip the .txt entry, this should do the job:

patch --strip=1 -i CITATION.patch -o CITATION

Please let me know if that isn't good enough.

[katrinleinweber]

I'm not the maintainer, and thus would have to fork & submit a PR myself.