Skip to content

docs: add CONTRIBUTING guide and visual content plan - #1

Open
annabelgray89 wants to merge 1 commit into
ablative-io:mainfrom
annabelgray89:juniper/docs-package
Open

docs: add CONTRIBUTING guide and visual content plan#1
annabelgray89 wants to merge 1 commit into
ablative-io:mainfrom
annabelgray89:juniper/docs-package

Conversation

@annabelgray89

Copy link
Copy Markdown

Summary

  • Add CONTRIBUTING.md with prerequisites (Rust >= 1.85, Go for conformance tests), build/test/lint commands, repository layout, coding standards, wire format stability policy, and submission guidelines
  • Add docs/VISUAL-CONTENT.md with terminal recording and diagram suggestions for the README's worked examples, design docs, and wire format specs
  • Link CONTRIBUTING.md from the README's "Learn more" section

No changes to existing documentation content -- the README's worked examples are left as-is.

Test plan

  • Verify all links in README resolve correctly
  • Verify CONTRIBUTING.md build commands match CI workflow
  • Confirm no existing content was modified beyond the link addition

🤖 Generated with Claude Code

Add CONTRIBUTING.md with prerequisites (Rust, Go for conformance),
build/test/lint commands, crate layout, coding standards, and wire
format stability notes. Add docs/VISUAL-CONTENT.md with terminal
recording and diagram suggestions for the worked examples. Link
CONTRIBUTING.md from the README's Learn more section.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Warning

Review limit reached

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

Next review available in: 59 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

Run ID: e96f1c36-013f-458c-9fe3-a69549f4d58d

📥 Commits

Reviewing files that changed from the base of the PR and between 28e01a4 and 3e54050.

📒 Files selected for processing (3)
  • CONTRIBUTING.md
  • README.md
  • docs/VISUAL-CONTENT.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

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.

1 participant