Skip to content

docs: add citation metadata - #99

Merged
timcogan merged 1 commit into
masterfrom
docs/add-citation-metadata
Jul 2, 2026
Merged

docs: add citation metadata#99
timcogan merged 1 commit into
masterfrom
docs/add-citation-metadata

Conversation

@timcogan

@timcogan timcogan commented Jul 2, 2026

Copy link
Copy Markdown
Owner

Summary by CodeRabbit

  • Documentation
    • Added citation metadata for the project to support proper referencing.
    • Updated the README with a new citation section and guidance on how to cite the project.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 558461e3-30b3-4adb-85e2-0b805c48f53a

📥 Commits

Reviewing files that changed from the base of the PR and between a34f0fd and 539f869.

📒 Files selected for processing (2)
  • CITATION.cff
  • README.md

📝 Walkthrough

Walkthrough

This PR adds citation metadata for the Perspecta DICOM Viewer project. CITATION.cff is populated with software and preferred-citation fields referencing a 2026 engrXiv preprint, and README.md gains a new "Citation" section referencing this file.

Changes

Citation metadata addition

Layer / File(s) Summary
Citation file and README update
CITATION.cff, README.md
CITATION.cff is populated with citation message, authorship, repository/project URLs, license, and preferred-citation details for the engrXiv preprint; README.md adds a "Citation" section instructing users to reference CITATION.cff.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Related Issues: None found in the provided context.

Related PRs: None found in the provided context.

Suggested labels: documentation

Suggested reviewers: timcogan

🐰 A citation file, crisp and new,
Points to a preprint, tried and true,
README now shows the way to cite,
Perspecta's roots, now in plain sight!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning No pull request description was provided, so the required summary, testing, screenshots, and checklist sections are missing. Add the template sections: Summary, Testing, Screenshots if needed, and Checklist, with a brief explanation of what changed and how it was verified.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the docs-only addition of citation 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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-citation-metadata

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.

@timcogan
timcogan merged commit 4c83445 into master Jul 2, 2026
10 checks passed
@timcogan
timcogan deleted the docs/add-citation-metadata branch July 2, 2026 15:19
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.

1 participant