Fix CITATION.cff top-level metadata - #1921
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdded a new CITATION.cff file containing citation metadata for the DP-GEN software, including citation format version, guidance message, software type, title, abstract, author information, repository and documentation URLs, license, and keywords. ChangesCitation File Addition
Estimated code review effort: 1 (Trivial) | ~2 minutes Related Issues: None specified Related PRs: None specified Suggested Labels: documentation Suggested Reviewers: None specified 🐰 A tiny file, crisp and new, 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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. Comment |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1921 +/- ##
=======================================
Coverage 49.80% 49.80%
=======================================
Files 83 83
Lines 14986 14986
=======================================
Hits 7464 7464
Misses 7522 7522 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
LGTM, thanks for the contribution! |
Related to #1916.
This keeps the existing article citation as
preferred-citation, and adds the required top-level CFF metadata for the software itself:cff-version, message, type, title, authors, repository, URL, license, and keywords.I intentionally did not change the existing preferred article citation.
Local checks:
CITATION.cffas YAML and checked thatcff-versionandpreferred-citationare present;git diff --check.I could not run
cffconvert --validatelocally becausecffconvertis not installed in this environment.Summary by CodeRabbit