Skip to content

docs(expo): add comment rule for agents - #10082

Merged
mikepitre merged 1 commit into
mainfrom
mike/expo-agents-comment-rule
Oct 5, 2026
Merged

mikepitre merged 1 commit into
mainfrom
mike/expo-agents-comment-rule

Conversation

@mikepitre

Copy link
Copy Markdown
Contributor

Description

Adds packages/expo/AGENTS.md with a short rule about code comments. It's the same rule we added to the native SDKs in clerk/clerk-ios#633 and clerk/clerk-android#1047, so agents working on the Swift and Kotlin code in this package follow the same guidance as in those repos.

The root AGENTS.md already tells agents not to write comments. This file narrows that for Expo: a comment is fine when it explains a constraint from a platform, library, or spec that we can't change. Anything else should be fixed in the code instead.

This only guides agents. There's no lint rule, and no existing comments are touched.

Checklist

  • Empty changeset, since nothing ships
  • pnpm test runs as expected.
  • pnpm build runs as expected.

Type of change

  • 📖 Refactoring / dependency upgrade / documentation

🤖 Generated with Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
clerk-js-sandbox Ready Ready Preview Oct 5, 2026 9:37pm UTC
swingset Ready Ready Preview Oct 5, 2026 9:37pm UTC

Request Review

@changeset-bot

changeset-bot Bot commented Oct 5, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: 99844e5

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions Bot added the expo label Oct 5, 2026
@coderabbitai

coderabbitai Bot commented Oct 5, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

🧰 Additional context used
📚 Code guidelines (1)
packages/expo/AGENTS.md — auto-discovered

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository YAML (base), Organization UI (inherited)
  • Review profile: ASSERTIVE
  • Plan: Team
  • Run ID: 7bbe03a9-ef77-4ba5-921b-e2c038fff0c6
📥 Commits

Reviewing files that changed from the base of the PR and between 99f3fc4 and 99844e5.

📒 Files selected for processing (2)
  • .changeset/expo-agents-comment-rule.md
  • packages/expo/AGENTS.md
🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 3 remain after this review.


📝 Walkthrough

Walkthrough

Added package-specific comment guidance for Expo code, including Swift and Kotlin files. The guidance limits comments to explanations of constraints and retains license headers, public API documentation, and section markers. It also prohibits commented-out code. Added an empty frontmatter block to a changeset file.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Merge Risk: ⚪ Minimal · up to 99844

This change adds Expo comment guidance and does not introduce a package release or runtime change. No actionable merge risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding a comment rule for agents in the Expo package.
Description check ✅ Passed The description explains the Expo agent guidance and its scope, which directly relates to the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@pkg-pr-new

pkg-pr-new Bot commented Oct 5, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@10082

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@10082

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@10082

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@10082

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@10082

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@10082

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@10082

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@10082

@clerk/expo-biometrics

npm i https://pkg.pr.new/@clerk/expo-biometrics@10082

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@10082

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@10082

@clerk/express

npm i https://pkg.pr.new/@clerk/express@10082

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@10082

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@10082

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@10082

@clerk/mosaic

npm i https://pkg.pr.new/@clerk/mosaic@10082

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@10082

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@10082

@clerk/react

npm i https://pkg.pr.new/@clerk/react@10082

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@10082

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@10082

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@10082

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@10082

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@10082

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@10082

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@10082

commit: 99844e5

@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-10-05T21:37:54.413Z

Summary

Metric Count
Packages analyzed 19
Packages with changes 0
🔴 Breaking changes 0
🟡 Non-breaking changes 0
🟢 Additions 0

No API Changes Detected

All packages have stable APIs with no detected changes.


Report generated by Break Check

Last ran on 99844e5.

@mikepitre
mikepitre merged commit c7e2958 into main Oct 5, 2026
58 of 59 checks passed
@mikepitre
mikepitre deleted the mike/expo-agents-comment-rule branch October 5, 2026 21:40

This branch was successfully deployed

2 active deployments
Preview – swingset — 99844e59 Deployed Oct 5, 2026 by vercel[bot]
Preview – clerk-js-sandbox — 99844e59 Deployed Oct 5, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants