feat: add citation file #908
Conversation
There was a problem hiding this comment.
Overall looks good, and while I didn't verify it, I assume that as you generated it with the helper that this is all valid and passes cffconvert --validate. I would make some revisions in terms of adding in version information into the citation and also the author list though.
Here's a CITAITON.cff file for a project that I'm a primary maintainer on as an example. (If you're not preparing the citation metadata to also populate the information in other services, like Zenodo, then things like doi are probably not relevant to you, but most of the rest of the information on there before the references I think is useful to make citation as easy and useful as possible for people.)
| # Visit https://bit.ly/cffinit to generate yours today! | ||
|
|
||
| cff-version: 1.2.0 | ||
| title: pixi |
There was a problem hiding this comment.
I haven't checked the codebase to see how you handle versioning release information, but I would add the version key here too.
There was a problem hiding this comment.
If you decide to incorporate the version here, please make a CI check that the version is synced with the one in Cargo.toml, otherwise it will drift 100%.
There was a problem hiding this comment.
More an "and" than an "or" but even if you only use VCS information for version information I would use some sort of version bump tool like tbump to try to go through and update information everywhere it exists.
There was a problem hiding this comment.
I would love to automate this but I want to automate the complete release and add this part to it. I've been experimenting with release-plz as rattler uses it but I haven't figure it out nicely yet. So in this PR I added the tbump as a preperation but it is not used in CI yet.
Added the versions to the urls 👍
CITATION.cff
Outdated
| authors: | ||
| - given-names: pixi open-source contributors |
There was a problem hiding this comment.
While I understand the idea to want to give credit to everyone who contributed, I would recommend adding the names of people who have "responsibility" for pixi within prefix.dev here.
There was a problem hiding this comment.
Followed your advice!
|
@matthewfeickert Thanks for the review! I was wondering, do you use a tool to update the versions everywhere when you want to do a release, or is it just search and replace? |
Yes. In
|
|
He @matthewfeickert, Thanks a lot for your input, I'm a little uncomfortable with the version stuff that's why I procrastinated this PR a little, sorry for that. I'll work on automating the bumping in a different PR as nothing about the release is automated currently but it is high on my radar. |
|
Sounds great @ruben-arts. Nothing to apologize for on your end though. I think it is very nice that this is being looked at period, so I don't think you should feel any timeline pressure here. 👍 |
Co-authored-by: Pavel Zwerschke <[email protected]>
Adding citation file as requested.
@matthewfeickert could you check if I did this correctly?
We decided to not name anyone in the citation directly but take everyone in by mentioning the contributors.
Closes #891