Skip to content

Fix CITATION.cff top-level metadata - #1921

Merged
wanghan-iapcm merged 1 commit into
deepmodeling:masterfrom
kernelpanic888:task24-fix-citation-cff-metadata
Jul 12, 2026
Merged

Fix CITATION.cff top-level metadata#1921
wanghan-iapcm merged 1 commit into
deepmodeling:masterfrom
kernelpanic888:task24-fix-citation-cff-metadata

Conversation

@kernelpanic888

@kernelpanic888 kernelpanic888 commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

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:

  • parsed CITATION.cff as YAML and checked that cff-version and preferred-citation are present;
  • git diff --check.

I could not run cffconvert --validate locally because cffconvert is not installed in this environment.

Summary by CodeRabbit

  • Documentation
    • Added citation information for DP-GEN, including how to reference the software, project details, author information, repository and documentation links, license, and keywords.

@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1eecf396-82d8-402a-ad0d-2f483e9ed6ef

📥 Commits

Reviewing files that changed from the base of the PR and between 932afac and b65461b.

📒 Files selected for processing (1)
  • CITATION.cff

📝 Walkthrough

Walkthrough

Added 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.

Changes

Citation File Addition

Layer / File(s) Summary
Add CITATION.cff metadata
CITATION.cff
New file defining citation format version, message, software type, title, abstract, authors, repository-code, url, license, and keywords for DP-GEN.

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,
Tells the world how to cite DP-GEN true,
With authors, license, and a URL bright,
CITATION.cff hops into the light!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly reflects the main change: updating CITATION.cff top-level metadata.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Jul 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 49.80%. Comparing base (932afac) to head (b65461b).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@wanghan-iapcm

Copy link
Copy Markdown
Contributor

LGTM, thanks for the contribution!

@wanghan-iapcm
wanghan-iapcm merged commit d5ce577 into deepmodeling:master Jul 12, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants