Replace CITATION.md with CITATION.cff

[adenzler-nvidia]

Summary

• Replaces CITATION.md with CITATION.cff so GitHub's "Cite this repository" widget works
• CITATION.md was not being recognized by GitHub — the widget requires the Citation File Format (.cff)
• Validated against CFF schema 1.2.0 using cffconvert

Test plan

• Verify "Cite this repository" button appears in the repo sidebar after merge

Summary by CodeRabbit

• Documentation
  • Updated project citation format to standardized Citation File Format (v1.2.0) with complete metadata including authors, project URL, license, and release information for improved citation reference management.

[coderabbitai]

📝 Walkthrough

Walkthrough

Added a standardized Citation File Format (CITATION.cff) with project metadata including version, authors, title, and license information. Removed the existing CITATION.md file that contained citation guidance and BibTeX examples.

Changes

Cohort / File(s)	Summary
Citation Configuration CITATION.cff, CITATION.md	Introduced CITATION.cff with standardized citation metadata (cff-version 1.2.0, authors, project URL, Apache-2.0 license, release date). Removed CITATION.md documentation that previously contained BibTeX citation examples and LaTeX usage instructions.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Replace CITATION.md with CITATION.cff' directly and accurately summarizes the main change: removing CITATION.md and introducing CITATION.cff as its replacement.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[adenzler-nvidia]

closes #1008

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

[coderabbitai]

🧹 Nitpick comments (2)

CITATION.cff (2)

7-7: Use repository-code instead of url for the GitHub source repository link.

CFF 1.2.0 defines repository-code as the dedicated key for a source code repository URL, distinct from url which is for a website/landing page. The CFF schema guide's expanded example consistently uses repository-code for GitHub repository links. Using url for a source code repository is semantically imprecise and may cause tools (Zenodo, Zotero, etc.) to not correctly identify the source repository.

♻️ Proposed fix

-url: "https://github.com/newton-physics/newton"
+repository-code: "https://github.com/newton-physics/newton"

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CITATION.cff` at line 7, The CITATION.cff entry uses the generic key `url`
for the GitHub repository; replace that key with the CFF-specific
`repository-code` key so the source code repo is correctly identified (i.e.,
change the `url: "https://github.com/newton-physics/newton"` entry to
`repository-code: "https://github.com/newton-physics/newton"` in the
CITATION.cff file).

---

1-9: Consider adding the version field.

The CFF 1.2.0 example from the official specification includes a version field alongside date-released, and adding fields like version helps create more descriptive metadata for the software. Without it, the auto-generated BibTeX and APA output from GitHub's "Cite this repository" widget will omit version information, reducing citation precision. Consider pinning the current release version.

♻️ Proposed addition

 date-released: "2025-04-22"
+version: "1.0.0"   # replace with the actual current release version

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CITATION.cff` around lines 1 - 9, Add a top-level version field to the
CITATION.cff metadata (e.g., add a line like version: "1.2.3") so GitHub and
citation tools include the release version; place it near the existing
cff-version and date-released entries and use the repository's released
tag/semantic version string to match the current release.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@CITATION.cff`:
- Line 7: The CITATION.cff entry uses the generic key `url` for the GitHub
repository; replace that key with the CFF-specific `repository-code` key so the
source code repo is correctly identified (i.e., change the `url:
"https://github.com/newton-physics/newton"` entry to `repository-code:
"https://github.com/newton-physics/newton"` in the CITATION.cff file).
- Around line 1-9: Add a top-level version field to the CITATION.cff metadata
(e.g., add a line like version: "1.2.3") so GitHub and citation tools include
the release version; place it near the existing cff-version and date-released
entries and use the repository's released tag/semantic version string to match
the current release.