Add CITATION.cff for standard software citation support#16
Conversation
Co-authored-by: dfeen87 <158860247+dfeen87@users.noreply.github.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Pull request overview
Adds a root-level CITATION.cff so GitHub can surface “Cite this repository” and export standard citation formats using CFF metadata.
Changes:
- Introduces a new
CITATION.cfffile using CFF v1.2.0 metadata (title, authors, license, URLs, abstract, keywords, DOIs).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| email: dfeen87@gmail.com | ||
| - family-names: "Krüger" | ||
| given-names: "Marcel" | ||
| year: 2025 |
There was a problem hiding this comment.
year is not a valid top-level key in CFF v1.2.0 (GitHub’s citation parser expects date-released for release date metadata). As written, this may cause GitHub to treat the file as invalid and not show the “Cite this repository” UI; replace year with date-released: YYYY-MM-DD (or omit the field if the exact date isn’t known).
| year: 2025 |
| title: "RAPS-HLV Flight Middleware: Advanced Safety & Predictive Intelligence Layer" | ||
| type: software | ||
| authors: | ||
| - family-names: "Feeney Jr." |
There was a problem hiding this comment.
For better citation formatting, consider modeling the “Jr.” portion as a name suffix (e.g., keep family-names as the surname and use the dedicated suffix field) so downstream formatters don’t treat the suffix as part of the last name.
| - family-names: "Feeney Jr." | |
| - family-names: "Feeney" | |
| name-suffix: "Jr." |
Adds a
CITATION.cfffile at the repo root so GitHub surfaces a native "Cite this repository" button, enabling one-click export in APA, BibTeX, and other formats.Changes
CITATION.cff(new): CFF v1.2.0 file populated from existing README metadata:10.5281/zenodo.17848351,10.5281/zenodo.17849083) as named identifiers✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.