Skip to content

Update README.md#1449

Merged
senamakel merged 2 commits into
mainfrom
senamakel-patch-1
May 10, 2026
Merged

Update README.md#1449
senamakel merged 2 commits into
mainfrom
senamakel-patch-1

Conversation

@senamakel
Copy link
Copy Markdown
Member

@senamakel senamakel commented May 10, 2026

Summary

  • What changed and why.
  • Keep this to 3-6 bullets focused on user-visible or architecture-impacting changes.

Problem

  • What issue or risk this PR addresses.
  • Include context needed for reviewers to evaluate correctness quickly.

Solution

  • How the implementation solves the problem.
  • Note important design decisions and tradeoffs.

Submission Checklist

If a section does not apply to this change, mark the item as N/A with a one-line reason. Do not delete items.

  • Tests added or updated (happy path + at least one failure / edge case) per Testing Strategy
  • Diff coverage ≥ 80% — changed lines (Vitest + cargo-llvm-cov merged via diff-cover) meet the gate enforced by .github/workflows/coverage.yml. Run pnpm test:coverage and pnpm test:rust locally; PRs below 80% on changed lines will not merge.
  • Coverage matrix updated — added/removed/renamed feature rows in docs/TEST-COVERAGE-MATRIX.md reflect this change (or N/A: behaviour-only change)
  • All affected feature IDs from the matrix are listed in the PR description under ## Related
  • No new external network dependencies introduced (mock backend used per Testing Strategy)
  • Manual smoke checklist updated if this touches release-cut surfaces (docs/RELEASE-MANUAL-SMOKE.md)
  • Linked issue closed via Closes #NNN in the ## Related section

Impact

  • Runtime/platform impact (desktop/mobile/web/CLI), if any.
  • Performance, security, migration, or compatibility implications.

Related

  • Closes:
  • Follow-up PR(s)/TODOs:

AI Authored PR Metadata (required for Codex/Linear PRs)

Keep this section for AI-authored PRs. For human-only PRs, mark each field N/A.

Linear Issue

  • Key:
  • URL:

Commit & Branch

  • Branch:
  • Commit SHA:

Validation Run

  • pnpm --filter openhuman-app format:check
  • pnpm typecheck
  • Focused tests:
  • Rust fmt/check (if changed):
  • Tauri fmt/check (if changed):

Validation Blocked

  • command:
  • error:
  • impact:

Behavior Changes

  • Intended behavior change:
  • User-visible effect:

Parity Contract

  • Legacy behavior preserved:
  • Guard/fallback/dispatch parity checks:

Duplicate / Superseded PR Handling

  • Duplicate PR(s):
  • Canonical PR:
  • Resolution (closed/superseded/updated):

Summary by CodeRabbit

  • Documentation
    • Revised README layout and header badges for improved alignment and presentation.
    • Added a short download banner to the installation section.
    • Rewrote feature descriptions for clearer explanations (token compression, messaging/privacy, related links).
    • Reworked the “Context in minutes, not weeks” narrative and image markup.
    • Expanded “Contributors Hall of Fame” with incentives and a Discord link.

Review Change Stack

@senamakel senamakel requested a review from a team May 10, 2026 01:22
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 10, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ed97af18-7b2d-4b2e-9495-4cebab059e6a

📥 Commits

Reviewing files that changed from the base of the PR and between 962026d and 0d8ae3d.

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

📝 Walkthrough

Walkthrough

README text and markup edits: centered Trendshift badge markup changed, an installation download banner added, the “What is OpenHuman?” features list rewritten, the “Context in minutes, not weeks” section and hero image markup updated, and the Contributors Hall of Fame line expanded with merch/Discord mention.

Changes

Documentation updates (README.md)

Layer / File(s) Summary
Header badge markup
README.md
Wraps the Trendshift badge link/image in an inline-block centered container.
Installation banner
README.md
Adds a one-line banner instructing users to download DMGs/EXEs from the website or terminal.
What is OpenHuman? feature list
README.md
Replaces the feature bullets with revised, expanded descriptions and adjusts the following contributor line.
Context / hero section
README.md
Rewrites the “Context in minutes, not weeks” copy and updates the hero image tag markup (removes alt) and descriptive paragraphs about syncing and local control.
Contributors Hall of Fame
README.md
Appends a sentence about merch, special access, and a Discord link.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Poem

🐰
I hopped through README lines with cheer,
Centered badges, messages clear,
Features fresh and context bright,
A tiny tweak to make docs light,
Discord bells and merch in sight.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update README.md' is vague and generic, describing only the file modified rather than the specific change made (adding a Star History badge with dark/light theme support). Consider a more specific title like 'Add Star History badge with theme support to README' to better convey the actual change to reviewers.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
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.


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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 9-16: The PR description currently contains an unfilled template;
update the PR body to complete the "Summary", "Problem", "Solution", "Impact"
sections with concrete content (Summary: 3–6 bullets of what changed and why;
Problem: the issue/risk addressed; Solution: how the change fixes it; Impact:
runtime/perf/security/compatibility implications) and mark the "Submission
Checklist" items as applicable or not, following the repo guideline and the
codex PR checklist; ensure the completed headings named "Summary", "Problem",
"Solution", "Impact", and "Submission Checklist" are present and accurate before
merging.
- Around line 9-16: Update the PR description to include a one- or two-sentence
justification for adding both Star History widgets: state why the new badge (the
/badge endpoint) is needed in addition to the existing chart (the /svg endpoint)
and what value each provides (e.g., quick rank indicator vs. historical trend),
referencing the added picture element that includes both the badge and the chart
so reviewers understand the intent.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4934ec77-14a9-41e5-81b5-4b8aaca9b93b

📥 Commits

Reviewing files that changed from the base of the PR and between 8a4ceaa and 962026d.

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

Comment thread README.md Outdated
Comment on lines +9 to +16

<a href="https://www.star-history.com/tinyhumansai/openhuman">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/badge?repo=tinyhumansai/openhuman&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/badge?repo=tinyhumansai/openhuman" />
<img alt="Star History Rank" src="https://api.star-history.com/badge?repo=tinyhumansai/openhuman" />
</picture>
</a>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚖️ Poor tradeoff

PR description template must be completed.

The PR description contains an unfilled template with empty Summary, Problem, Solution, and Impact sections, and an unchecked Submission Checklist. This violates the repository's coding guidelines.

As per coding guidelines: "AI-authored issues and PRs must follow the respective templates verbatim" and "Before opening AI-authored PRs from Codex web or Linear-launched agents, follow the checklist in docs/agent-workflows/codex-pr-checklist.md."

Please complete the following in the PR description:

  • Summary: 3-6 bullets describing what changed and why
  • Problem: The issue or risk this addresses
  • Solution: How this implementation solves the problem
  • Impact: Runtime/performance/security/compatibility implications
  • Submission Checklist: Verify applicable items (note: coverage requirements apply to code changes, not documentation-only PRs)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 9 - 16, The PR description currently contains an
unfilled template; update the PR body to complete the "Summary", "Problem",
"Solution", "Impact" sections with concrete content (Summary: 3–6 bullets of
what changed and why; Problem: the issue/risk addressed; Solution: how the
change fixes it; Impact: runtime/perf/security/compatibility implications) and
mark the "Submission Checklist" items as applicable or not, following the repo
guideline and the codex PR checklist; ensure the completed headings named
"Summary", "Problem", "Solution", "Impact", and "Submission Checklist" are
present and accurate before merging.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Description: Check for any existing star-history references and badge patterns in docs

# Search for all star-history references
rg -n "star-history" --type=md

# Search for badge patterns in README to understand badge strategy
rg -n "badge|img.*src.*api\." README.md -A 1 -B 1

Repository: tinyhumansai/openhuman

Length of output: 2408


Add a brief explanation in the PR description justifying why both the badge and chart are needed.

The README now contains two Star History widgets from the same service: the new badge (using /badge endpoint) alongside the existing chart (using /svg endpoint). While they serve different purposes (rank indicator vs. historical trend), the PR description does not explain the rationale for adding the badge or what problem it solves. Per coding guidelines, new changes should include documentation of intent—add a brief line to the PR summary describing why both visualizations are valuable.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 9 - 16, Update the PR description to include a one-
or two-sentence justification for adding both Star History widgets: state why
the new badge (the /badge endpoint) is needed in addition to the existing chart
(the /svg endpoint) and what value each provides (e.g., quick rank indicator vs.
historical trend), referencing the added picture element that includes both the
badge and the chart so reviewers understand the intent.

@senamakel senamakel merged commit 8ed738a into main May 10, 2026
20 of 22 checks passed
@senamakel senamakel deleted the senamakel-patch-1 branch May 10, 2026 02:46
AusAgentSmith pushed a commit to AusAgentSmith/openhuman that referenced this pull request May 23, 2026
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