Skip to content

Add citation and fix logo#17

Merged
d33bs merged 2 commits into
WayScience:mainfrom
d33bs:fixes
Apr 21, 2026
Merged

Add citation and fix logo#17
d33bs merged 2 commits into
WayScience:mainfrom
d33bs:fixes

Conversation

@d33bs

@d33bs d33bs commented Apr 21, 2026

Copy link
Copy Markdown
Member

This PR adds the Zenodo citation and fixes the logo.

Summary by CodeRabbit

  • Documentation
    • Added a permanent Digital Object Identifier (DOI) enabling persistent project citation for academic and research purposes
    • Expanded author information with four additional contributors and their associated ORCID identifiers for proper attribution
    • Improved README header with multiple status badges providing visibility into build health, package versions, and code quality indicators

@coderabbitai

coderabbitai Bot commented Apr 21, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@d33bs has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 1 minutes and 17 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 1 minutes and 17 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5bf7007f-8678-40fb-bc7d-753856c0f86e

📥 Commits

Reviewing files that changed from the base of the PR and between 9ca2547 and b7a5d3a.

📒 Files selected for processing (1)
  • README.md
📝 Walkthrough

Walkthrough

The PR adds metadata and documentation updates: a DOI field and four new authors with ORCID identifiers to CITATION.cff, and updates the README logo URL while adding status badges for Zenodo DOI, PyPI version, build status, Ruff, and uv.

Changes

Cohort / File(s) Summary
Citation Metadata
CITATION.cff
Added DOI field (10.5281/zenodo.19672521) and four new authors (Jenna Tomkinson, Michael Lippincott, Cameron Mattson, Gregory Way) with corresponding ORCID identifiers.
README Documentation
README.md
Updated logo image URL from relative path to raw GitHub-hosted URL; added five status badges (Zenodo DOI, PyPI version, GitHub Actions build, Ruff, uv).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Metadata hops with ORCID pride,
DOI shines on the Zenodo side,
Badges now gleam in a colorful row,
Authors recorded for all who should know,
A citation so grand, ready to glow! ✨

🚥 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 accurately summarizes the main changes: adding citation metadata (doi field and authors in CITATION.cff) and fixing the logo (updating README image URL and adding badges).
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

1-1: Use a canonical logo source instead of a fork-hosted raw URL.

Line 1 points to d33bs/iceberg-bioimage; this can break if that fork changes or is removed. Prefer a repo-relative path (if rendering target supports it) or raw.githubusercontent.com/WayScience/iceberg-bioimage/... for stability.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 1, Replace the image src that currently points to
"https://raw.githubusercontent.com/d33bs/iceberg-bioimage/main/docs/src/_static/iceberg-bioimage-logo.png"
in the README's <img> tag with a stable canonical source: either a repo-relative
path (e.g., docs/src/_static/iceberg-bioimage-logo.png) if the rendering target
supports relative assets, or the official raw URL under the main org
"https://raw.githubusercontent.com/WayScience/iceberg-bioimage/main/docs/src/_static/iceberg-bioimage-logo.png";
keep the same alt text and width attributes to preserve rendering.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 6: Wrap the PyPI badge image markdown (the line containing the image URL
https://img.shields.io/pypi/v/iceberg-bioimage) in a link to the package page
(e.g., https://pypi.org/project/iceberg-bioimage/) so the badge becomes
clickable; update the README.md badge line to use the standard linked format
[![PyPI -
Version](https://img.shields.io/pypi/v/iceberg-bioimage)](https://pypi.org/project/iceberg-bioimage/).

---

Nitpick comments:
In `@README.md`:
- Line 1: Replace the image src that currently points to
"https://raw.githubusercontent.com/d33bs/iceberg-bioimage/main/docs/src/_static/iceberg-bioimage-logo.png"
in the README's <img> tag with a stable canonical source: either a repo-relative
path (e.g., docs/src/_static/iceberg-bioimage-logo.png) if the rendering target
supports relative assets, or the official raw URL under the main org
"https://raw.githubusercontent.com/WayScience/iceberg-bioimage/main/docs/src/_static/iceberg-bioimage-logo.png";
keep the same alt text and width attributes to preserve rendering.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9d490adf-df47-409c-b6ed-17d33a1f7d16

📥 Commits

Reviewing files that changed from the base of the PR and between 072779c and 9ca2547.

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

Comment thread README.md Outdated
@d33bs
d33bs merged commit 4bf4f52 into WayScience:main Apr 21, 2026
9 checks passed
@d33bs
d33bs deleted the fixes branch April 21, 2026 18:41
@coderabbitai coderabbitai Bot mentioned this pull request Jul 17, 2026
11 tasks
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