Conversation
benedict-armstrong
requested review from
francescoshox and
phnazari
as code owners
|
Important Installation incomplete: to start using Gemini Code Assist, please ask the organization owner(s) to visit the Gemini Code Assist Admin Console and sign the Terms of Services. |
There was a problem hiding this comment.
Pull request overview
Adds a CITATION.cff file so GitHub can automatically surface “Cite this repository” metadata for the project.
Changes:
- Introduces a
CITATION.cffwith project title, authors, repository URL, abstract, keywords, and license metadata.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| metadata from this file. | ||
| type: software | ||
| authors: | ||
| - given-names: Philipp |
There was a problem hiding this comment.
Can you put a star behind all three of our names?
|
Actually idk if we want this. Because in the end this creates two different ways of citing the repo. How does Fla do this? |
|
@benedict-armstrong okay, so I think the way to go is the following: add this CITATION.md and then edit the citation at the end of the README.md to exactly match the one created by CITATION.md. Once this is done, can you let me know? Because I will also update the citation mentioned in the docs then. @francescoshox can you approve this PR afterwards? |
Updated title and release date in CITATION.cff
| # Visit https://bit.ly/cffinit to generate yours today! | ||
|
|
||
| cff-version: 1.2.0 | ||
| title: "discretax: A Lightweight Collection of State Space Models in JAX" |
There was a problem hiding this comment.
I guess we should write Discretax and not discretax
@phnazari @benedict-armstrong wdyt?
There was a problem hiding this comment.
Sure. But I actually think we might not want to include this CITATION.cff because it is risky. We do not want two different ways of citing this repo. If we merge this PR, we always have to make sure that all three citations match: at the end of the README, at the end of the main page in the docs and in CITATION.cff
Description
Type of Change
Changes Made
Adds a CITATION.cff. Github will automatically parse this and add a button to the repository. See image below and citations on github.