Skip to content

feat(review): add a shared beta-collapsible convention for the PR comment - #5769

Merged
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
nickmopen:feat/beta-collapsible-convention
Jul 14, 2026
Merged

feat(review): add a shared beta-collapsible convention for the PR comment#5769
loopover-orb[bot] merged 1 commit into
JSONbored:mainfrom
nickmopen:feat/beta-collapsible-convention

Conversation

@nickmopen

Copy link
Copy Markdown
Contributor

Summary

The [BETA] Chat with LoopOver collapsible (#5078) — the first experimental feature surfaced in the public PR comment — was visually identical to every stable collapsible above it; the only "beta" signal was three characters of literal text in the title, easy to miss. As more experimental features ship into this comment, a reader had no way to tell "new/unstable" from "solid for months" at a glance.

This adds a single reusable convention (#5096):

  • buildBetaCollapsible() wrapper — any beta feature routes through it, so the next one gets the same treatment for free (not copy-pasted per feature).
  • A consistent 🧪 badge on the title (stronger than a [BETA] text prefix) + a one-line 🧪 Experimental — new and may change. disclaimer auto-appended to the body.
  • Degrades cleanly — an empty body yields an empty (thus skipped) collapsible, so a repo with no beta features enabled sees nothing extra (never a bare 🧪 header over nothing).
  • Migrates the existing chat collapsible to it, and fixes the em-dash / double-hyphen inconsistency in its copy (--).
  • Static text only (no author/finding input), so it's public-safe by construction.

Scope

  • The PR title follows type(scope): short summary Conventional Commit format.
  • This PR is focused and does not mix unrelated changes.
  • This follows CONTRIBUTING.md and does not reintroduce GitHub Pages, VitePress, site/, or CNAME.
  • I linked a currently open issue this PR resolves — Closes #5096.

Validation

  • git diff --check
  • npm run typecheck — clean on the changed files
  • Vitest — 376 tests green across the affected comment-builder suites (unified-comment-parity, ops-wire, queue-4, queue-5, signals-coverage); new test asserts the badge + disclaimer + em-dash consistency, and the existing empty-degrade test still holds
  • Branch coverage confirmed on the new buildBetaCollapsible (both the empty and non-empty sides are exercised)

If any required check was skipped, explain why:

  • Backend-only change (src/signals/engine.ts builds PR-comment markdown, not a UI page) — no UI Evidence / screenshot; output is asserted via unit tests.

Safety

  • No secrets, wallets, hotkeys, coldkeys, PATs, trust scores, private rankings, or reward/payout fields are exposed — the wrapper interpolates only static text (a badge + a fixed disclaimer), no author/finding input.
  • Public GitHub text stays sanitized, low-noise, and implies no compensation guarantees or optimization tactics.
  • API/OpenAPI/MCP behavior updated and tested where needed (N/A — internal comment rendering only).
  • No changelog edited.

Notes

  • Chose the simplest of the issue's suggested conventions (a consistent badge + auto-appended disclaimer via a shared helper) over a separate "Beta features" super-section, to keep the collapsible ordering stable and the change minimal; the helper makes switching to a super-section later a one-place change.

Closes #5096

…ment

The '[BETA] Chat with LoopOver' collapsible (JSONbored#5078) was visually identical to every stable
collapsible above it — the only 'beta' signal was three characters of literal text in the title, easy
to miss as more experimental features ship into this comment.

Adds a reusable buildBetaCollapsible() wrapper (JSONbored#5096): a consistent 🧪 badge on the title plus a
one-line 'Experimental — new and may change.' disclaimer auto-appended to the body, so the next beta
feature gets the same treatment for free. Degrades cleanly — an empty body yields an empty (skipped)
collapsible, so a repo with no beta features shows nothing extra. Migrates the existing chat collapsible
to it and fixes the em-dash/double-hyphen inconsistency in its copy. Static text only, public-safe by
construction.

Closes JSONbored#5096
@nickmopen
nickmopen requested a review from JSONbored as a code owner July 14, 2026 13:21
@superagent-security

Copy link
Copy Markdown
Contributor

Superagent didn't find any vulnerabilities or security issues in this PR.

@codecov

codecov Bot commented Jul 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.07%. Comparing base (e85528a) to head (29fbe3a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5769   +/-   ##
=======================================
  Coverage   95.07%   95.07%           
=======================================
  Files         582      582           
  Lines       46212    46216    +4     
  Branches    14819    14820    +1     
=======================================
+ Hits        43936    43940    +4     
  Misses       1516     1516           
  Partials      760      760           
Flag Coverage Δ
shard-1 43.40% <50.00%> (-0.54%) ⬇️
shard-2 36.01% <50.00%> (+0.25%) ⬆️
shard-3 32.20% <25.00%> (-0.06%) ⬇️
shard-4 32.81% <100.00%> (-0.12%) ⬇️
shard-5 31.33% <25.00%> (-0.40%) ⬇️
shard-6 44.99% <50.00%> (+0.34%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
src/signals/engine.ts 97.49% <100.00%> (+<0.01%) ⬆️
🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@loopover-orb loopover-orb Bot added the gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier. label Jul 14, 2026
@loopover-orb

loopover-orb Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Tip

🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩

✅ LoopOver review result - approve/merge recommended

Review updated: 2026-07-14 13:29:07 UTC

2 files · 1 AI reviewer · no blockers · readiness 100/100 · CI green · clean

✅ Suggested Action - Approve/Merge

  • safe to merge

Review summary
This adds a small, well-scoped buildBetaCollapsible() wrapper that badges beta collapsible titles with 🧪 and appends a static disclaimer, migrates the existing chat-beta collapsible to it, and fixes the double-hyphen/em-dash inconsistency in the routing copy. The empty-body degrade path is preserved (badge only applied to title, body stays empty when bodyLines is empty), and tests were updated to match the new title string and assert the badge/disclaimer/em-dash. This is a low-risk, mechanical, well-tested change that closes the linked issue #5096.

Nits — 5 non-blocking
  • src/signals/engine.ts: the large doc comment above buildBetaCollapsible duplicates most of the PR description verbatim — consider trimming to the non-obvious invariant (empty body ⇒ empty collapsible) only.
  • test/unit/unified-comment-parity.test.ts: the new test and the existing gating tests both hardcode the literal "🧪 Chat with LoopOver" string in multiple places — a small helper or constant would reduce repetition if more beta collapsibles are added later.
  • src/signals/engine.ts: BETA_COLLAPSIBLE_DISCLAIMER is a module-level constant but buildBetaCollapsible itself isn't exported for reuse verification outside this file — confirm it's exported if other modules will route beta features through it as claimed.
  • Consider exporting buildBetaCollapsible (if not already) so future beta features in other files can reuse it as the PR description promises.
  • A follow-up could add a lightweight lint/test check that no other collapsible title contains a literal "[BETA]" prefix, to enforce the new convention going forward.
Signal Result Evidence
Code review ✅ No blockers 1 reviewer
Linked issue ✅ Linked #5096
Related work ✅ No active overlap found No same-issue or scoped active PR overlap found.
Change scope ✅ 20/20 Low review scope from cached public metadata (1 linked issue).
Validation posture ✅ 25/25 PR body includes validation/test evidence.
Contributor workload ✅ 10/10 Author activity: 127 registered-repo PR(s), 78 merged, 9 issue(s).
Contributor context ✅ Confirmed Gittensor contributor nickmopen; Gittensor profile; 127 PR(s), 9 issue(s).
Gate result ✅ Passing No configured blocker found.
Improvement ✅ Minor risk: clean · value: minor — Code changes are accompanied by test evidence. LLM value judgment: minor — The change is a small, focused visual/DX improvement (badge + disclaimer wrapper) that directly closes the linked issue without expanding scope, but it affects only one existing collapsible so its immediate impact is limited until more beta features adopt it.
Linked issue satisfaction

Addressed
The PR introduces a single reusable buildBetaCollapsible() helper (badge + disclaimer) as required, migrates the existing chat collapsible to it, fixes the em-dash/double-hyphen inconsistency, and adds tests covering both the wrapper's badge/disclaimer and the empty-degrade behavior. The chosen convention (icon badge + disclaimer) is a reasonable single design rather than the 2-3 proposed options

Review context
  • Author: nickmopen
  • Role context: outside_contributor
  • Public audience mode: oss maintainer
  • Lane context: Repository is configured for direct PR review.
  • Public profile languages: not available
  • Official Gittensor activity: 127 PR(s), 9 issue(s).
  • PR-specific overlap: none found.
Contributor next steps
  • Keep the PR focused and include validation evidence before maintainer review.
Signal definitions
  • Related work = same linked issue, overlapping active PRs, or title/path similarity.
  • Change scope = cached public metadata such as size labels, draft state, and review-burden hints.
  • Validation posture = whether the PR provides enough public validation/test evidence for maintainer review.
  • Contributor workload = public contributor activity and cleanup pressure, not a repo-wide quality failure.
  • Contributor context = public GitHub/Gittensor identity context; non-Gittensor status is not a blocker.
[BETA] Chat with Gittensory

Ask Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.

  • @gittensory ask &lt;question&gt; answers contribution-quality Q&A with source citations and freshness.
  • @gittensory chat &lt;question&gt; answers in natural prose from cached decision-pack facts via local inference (maintainer/collaborator; read-only).
  • A plain-language @gittensory mention with a real question is routed to the closest matching read-only command automatically -- no exact syntax required.

Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands

🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed


💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →.

Checked by LoopOver, a quiet PR intelligence layer for OSS maintainers.

  • Re-run LoopOver review

@loopover-orb loopover-orb Bot left a comment

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.

Gittensory approves — the gate is satisfied and CI is green.

@loopover-orb
loopover-orb Bot merged commit 97c98b3 into JSONbored:main Jul 14, 2026
15 checks passed
This was referenced Jul 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gittensor:feature Gittensor-scored feature linked to a feature issue — scores a 0.25x multiplier.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Visually distinguish BETA/experimental review-comment features from stable ones

1 participant