Skip to content

add weekly readme updater#78

Merged
tonywu1999 merged 4 commits intodevelfrom
upgrade-readme
Mar 3, 2026
Merged

add weekly readme updater#78
tonywu1999 merged 4 commits intodevelfrom
upgrade-readme

Conversation

@tonywu1999
Copy link
Contributor

@tonywu1999 tonywu1999 commented Mar 3, 2026

Motivation and Context

The README is the most important place that users to see when trying out a new package. Right after that, it's the vignette (although, we can likely make the README very similar to one of our vignettes).

The README should continuously be updated given new commits and exported functions and better documentation over time.

Changes

  • Add an automation script to update a section of the README every week.

Testing

Verified this works, see #79

Checklist Before Requesting a Review

  • I have read the MSstats contributing guidelines
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules
  • Ran styler::style_pkg(transformers = styler::tidyverse_style(indent_by = 4))
  • Ran devtools::document()

@coderabbitai
Copy link

coderabbitai bot commented Mar 3, 2026

Warning

Rate limit exceeded

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

⌛ 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.

📥 Commits

Reviewing files that changed from the base of the PR and between 094c3f7 and e49b52d.

📒 Files selected for processing (3)
  • .github/scripts/extract_exports.py
  • .github/scripts/upgrade_readme.py
  • .github/workflows/weekly-readme-upgrade.yml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch upgrade-readme

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.

@tonywu1999 tonywu1999 merged commit 1648dab into devel Mar 3, 2026
4 checks passed
@tonywu1999 tonywu1999 deleted the upgrade-readme branch March 3, 2026 22:30
@codecov-commenter
Copy link

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.66%. Comparing base (094c3f7) to head (e49b52d).
⚠️ Report is 2 commits behind head on devel.

Additional details and impacted files
@@           Coverage Diff           @@
##            devel      #78   +/-   ##
=======================================
  Coverage   78.66%   78.66%           
=======================================
  Files           7        7           
  Lines         825      825           
=======================================
  Hits          649      649           
  Misses        176      176           

☔ 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.

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.

2 participants