Skip to content

docs: add agent instruction entrypoints - #30

Closed
casper-phantom[bot] wants to merge 1 commit into
mainfrom
casper/agent-instructions-symlink
Closed

casper-phantom[bot] wants to merge 1 commit into
mainfrom
casper/agent-instructions-symlink

Conversation

@casper-phantom

@casper-phantom casper-phantom Bot commented Aug 18, 2026 •

Copy link
Copy Markdown

Note

Low risk: This documentation-only change leaves package code, native bridges, the submodule pointer, and generated AAR unchanged.

Summary

  • Add repository-specific guidance for the React Native package, native bridges, demos, and Juicebox SDK submodule.
  • Record the pinned Node and Yarn setup plus the existing lint, type-check, test, package-build, and AAR workflows.
  • Expose one canonical instruction file through both root entrypoints.

Agent provenance

  • implementation: Oz — not exposed by host / not exposed by host

Casper-Issue-Key: react-native-juicebox-sdk/agent-instructions-symlink
casper-run-id: 01a015f1-7a8c-72c8-8f70-7536ff5bd926

Summary by CodeRabbit

  • Documentation
    • Added repository guidance covering project structure, setup requirements, validation commands, testing, builds, Android artifact rebuilding, and CI prerequisites.
    • Added a linked reference so the same guidance is available through both documentation entry points.

Co-authored-by: casper-phantom <273411261+phantom-autopilot@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Aug 18, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5b3cb1fc-1935-46fb-b211-f447c8c06632

📥 Commits

Reviewing files that changed from the base of the PR and between 4356441 and eb61a4b.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md

Limit details: You’ve used all 1 included review currently available under your plan. You completed 73 included PR reviews in the past 7 days; at that activity level, included reviews refill at 1 review per hour.


📝 Walkthrough

Walkthrough

The pull request adds repository development guidance in AGENTS.md and exposes the same guidance through a symbolic link at CLAUDE.md.

Changes

Repository guidance

Layer / File(s) Summary
Development guidance and tooling link
AGENTS.md, CLAUDE.md
AGENTS.md documents the React Native SDK structure, required Node.js and Yarn versions, validation commands, submodule setup, Android AAR regeneration, and CI lockfile requirements. CLAUDE.md links to AGENTS.md.

Merge Risk: ⚪ Minimal · up to eb61a

This documentation-only PR adds repository guidance and a shared root instruction entrypoint without changing package code, native bridges, dependencies, generated artifacts, or deployment behavior; no actionable merge-blocking risk remains after normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the documentation change that adds repository agent instruction entrypoints.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch casper/agent-instructions-symlink

Usage-based review receipt

Note

This review was completed with usage-based billing: files reviewed beyond your plan's included limits are billed at $0.25/file. Track spend and usage in your billing settings.


Comment @coderabbitai help to get the list of available commands.

@casper-phantom

Copy link
Copy Markdown
Author

Closing this rollout PR because the repository did not already have root AGENTS.md or CLAUDE.md guidance. We only want to add the reciprocal entrypoint where substantive instructions already exist.

@casper-phantom casper-phantom Bot closed this Aug 18, 2026
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