Skip to content

docs: add CONTRIBUTING.md and document updater EXE usage#48

Merged
hieuck merged 1 commit into
mainfrom
feature/docs-contributing-readme
Jul 8, 2026
Merged

docs: add CONTRIBUTING.md and document updater EXE usage#48
hieuck merged 1 commit into
mainfrom
feature/docs-contributing-readme

Conversation

@hieuck

@hieuck hieuck commented Jul 8, 2026

Copy link
Copy Markdown
Owner

Summary\r\nImprove contributor and user documentation.\r\n\r\n## Changes\r\n- Add with the bug/feature workflow, worktree conventions, test requirements, and conventional commit guidance.\r\n- Update with an section explaining how works and why it is needed.\r\n\r\nCloses #43. Closes #44.

- Add CONTRIBUTING.md with workflow, conventions, and test instructions.

- Extend README with an Auto-Update Behavior section.

- Explain why the updater EXE is needed and how it works.

Closes #43. Closes #44.
@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@hieuck, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 24 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 79afed53-9e67-4c90-a378-6cf67af9e120

📥 Commits

Reviewing files that changed from the base of the PR and between 57b6dd3 and eea31a7.

📒 Files selected for processing (2)
  • CONTRIBUTING.md
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/docs-contributing-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.

@hieuck hieuck merged commit 2d48112 into main Jul 8, 2026
2 checks passed
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.

[Docs] Update README for updater EXE usage

1 participant