add citation file - Githubissues

mit-dci / opencbdc-tx

A transaction processor for a hypothetical, general-purpose, central bank digital currency

Other

896 stars 198 forks source link

add citation file #292

Closed eolesinski closed 1 month ago

eolesinski commented 1 month ago

This PR addresses issue #208 by adding a CITATION.cff file to the repository.

This addition offers several benefits:

Clarifies the preferred citation and provides a standardized format for citing the project
Follows the example of other prominent open-source projects (e.g. PyTorch, Pandas)
Provides a citation for all developers (OpenCBDC Development Team) in addition to an academic citation
Adds a 'cite this repository' link to the repository's sidebar
Autogenerates copyable BibTeX and APA citations

Note: this still leaves room to add an AUTHORS.md file and refine the copyright statement (#147)

HalosGhost commented 1 month ago

I think this is a great addition! Last time I looked at CFF, I couldn't figure out a way to enforce capitalization in the output bibtex (e.g., such that the bibtex specifies {USENIX} and {NSDI} to ensure they're not mangled by a TeX engine); is there any way around that? Similarly, the bibtex doesn't actually include the pages in the output for some reason. Can we control which properties are output?

If not, then I think the format is unfortunately limited, but I'm happy to merge this regardless. If so, let's ensure the capitalization of the proceedings is at least correct.

eolesinski commented 1 month ago

@HalosGhost fixed the page number formatting so that they appear in both the bibtex- and APA-style citations.

Unfortunately, it doesn't look like there is a great way to print special characters into the bibtex entry; however, it does look like the current conversion at least perseveres the capitalization and (BibTex inproceedings) uses ACM in their documentation so I still think it is worth merging. Of course up to you though.