Skip to content

docs: describe fgumi as a research preview instead of alpha - #248

Merged
nh13 merged 1 commit into
mainfrom
nh/readme-research-preview
Apr 9, 2026
Merged

nh13 merged 1 commit into
mainfrom
nh/readme-research-preview

Conversation

@nh13

@nh13 nh13 commented Apr 9, 2026

Copy link
Copy Markdown
Member

Summary

  • Rebrand README warning from "ALPHA SOFTWARE" to "RESEARCH PREVIEW"

@nh13
nh13 temporarily deployed to github-actions April 9, 2026 02:34 — with GitHub Actions Inactive
@nh13
nh13 marked this pull request as ready for review April 9, 2026 02:35
@nh13 nh13 added the documentation Improvements or additions to documentation label Apr 9, 2026
@codecov

codecov Bot commented Apr 9, 2026 •

Copy link
Copy Markdown

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #248      +/-   ##
==========================================
- Coverage   89.29%   89.29%   -0.01%     
==========================================
  Files         118      118              
  Lines       57201    57201              
==========================================
- Hits        51080    51079       -1     
- Misses       6121     6122       +1     

☔ View full report in Codecov by Sentry.
📢 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.

@nh13
nh13 force-pushed the nh/readme-research-preview branch from 85e210e to b002ee4 Compare April 9, 2026 02:37
@nh13
nh13 temporarily deployed to github-actions April 9, 2026 02:37 — with GitHub Actions Inactive
@nh13
nh13 merged commit aa9e26c into main Apr 9, 2026
7 of 8 checks passed
@nh13
nh13 deleted the nh/readme-research-preview branch April 9, 2026 02:40
@nh13 nh13 mentioned this pull request Apr 8, 2026
@coderabbitai

coderabbitai Bot commented Apr 9, 2026 •

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 38f4a08b-79e5-426b-9386-ef6c8c2d126e

📥 Commits

Reviewing files that changed from the base of the PR and between 85e210e and b002ee4.

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

📝 Walkthrough

Walkthrough

The README's maturity status banner has been updated from "ALPHA SOFTWARE" to "RESEARCH PREVIEW" with corresponding changes to the disclaimer text from "currently in ALPHA" to "currently a research preview." The disclaimer retains the existing language about no guarantees regarding correctness or stability. The changes involved minor sentence restructuring across multiple lines.

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Title check ⚠️ Warning Title describes only the README rebranding change, but commit history shows major performance/correctness overhaul to sort worker-pool, which is the substantial actual work. Update title to reflect the primary change: performance/correctness improvements to Phase 2 sort worker-pool design, or split into separate PRs.
Description check ⚠️ Warning Description only mentions the README rebranding but omits the major sort worker-pool redesign detailed in commit history, creating a significant mismatch. Update description to include the sort worker-pool overhaul, Phase2FileState redesign, deadlock/race fixes, and Rayon threading improvements.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch nh/readme-research-preview

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.

This branch was previously deployed

1 inactive deployment
github-actions — b002ee40 Deployed Apr 9, 2026 by nh13 via coverage #995
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant