docs: add CONTRIBUTING with git flow branching model#649
Conversation
|
Warning Review limit reached
Next review available in: 42 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds ChangesContributor Workflow
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
c0a895b to
f7d620d
Compare
There was a problem hiding this comment.
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 `@CONTRIBUTING.md`:
- Around line 18-22: Update the fenced block in the contributing documentation
to include a `text` or `console` language identifier immediately after the
opening fence, while preserving the existing diagram content.
- Line 54: Update the release-job condition in the build workflow so version-tag
push events are not blocked by github.event.base_ref, which is unset for tag
pushes. Preserve the intended main-branch release gating through an appropriate
trigger or condition, then update the tagging guidance in CONTRIBUTING.md to
match the working GA build flow.
🪄 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: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 8bd5334d-377e-4d80-be3e-2b4e5b9dfbca
📒 Files selected for processing (1)
CONTRIBUTING.md
7421b97 to
dcf555b
Compare
Ahmath-Gadji
left a comment
There was a problem hiding this comment.
Docs-only change (CONTRIBUTING.md, git flow branching model). Verified branch names, commands, and CI workflow references against the actual repo state — all accurate. CodeRabbit's two findings addressed: markdownlint MD040 fixed, and the base_ref/GA-build claim confirmed correct against real release history (v1.1.5–v2.0.0 all built successfully on tag push).
Satisfies markdownlint MD040 (fenced-code-language).
dcf555b to
cecd224
Compare
Documents the git flow branching model the team is adopting: long-lived
main(production/tags) anddevelop(integration), withfeature/*,release/X.Y.Z, andhotfix/*short-lived branches.Covers:
Summary by CodeRabbit