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 files #891

Closed
ruben-arts opened this issue Mar 1, 2024 Discussed in #881 · 1 comment · Fixed by #908
Closed

Add citation files #891

ruben-arts opened this issue Mar 1, 2024 Discussed in #881 · 1 comment · Fixed by #908

Comments

@ruben-arts
Copy link
Contributor

Discussed in #881

Originally posted by twrightsman February 28, 2024
Is there a preferred way of citing pixi? I currently have the following in BibTeX, using guidance from the Academia StackExchange:

@misc{bib-pixi,
  author = {Arts, Ruben and Zalmstra, Bas and de Jager, Tim and Vollprecht, Wolf},
  title = {pixi},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/prefix-dev/pixi}},
  commit = {745862373f60a90c77b70fb68365af54614d571e}
}

This renders in APA format as:

Arts, R., Zalmstra, B., Jager, T. de, & Vollprecht, W. (2023). pixi. GitHub.

Is this appropriate? I have little idea which contributors should be listed and in which order, so I restricted it to just the prefix.dev team.

@ruben-arts ruben-arts added the needs-decision Undecided if this should be done label Mar 1, 2024
@matthewfeickert
Copy link
Contributor

matthewfeickert commented Mar 2, 2024

👋 I would enthusiastically advocate that you use CITATION.cff files, as you already linked above, instead of BibTeX for the repo. While both CITATION.cff and a CITATION.bib will give you a clickable "Cite this repository badge" (respective examples: Awkward Array and Matplotlib) CITATION.cff is starting to gain more traction and also has nice exporter tools like cffconvert. While it is perhaps more niche, Zenodo also knows how to properly handle CITATION.cff files while making a long term preservation archive and minting a DOI for a corresponding GitHub release.

Regardless, thank you for thinking about making citation of pixi a straightforward thing! Software citation practices is something near to my heart, and so it always makes me happy when great projects like pixi also make it easy for people to do the right thing and properly cite them. 😄

@ruben-arts ruben-arts removed the needs-decision Undecided if this should be done label Mar 4, 2024
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 a pull request may close this issue.

2 participants