Skip to content

chore(repo): Introduce basic AGENTS.md file#8566

Open
brkalow wants to merge 3 commits into
mainfrom
brk.chore/agents-md
Open

chore(repo): Introduce basic AGENTS.md file#8566
brkalow wants to merge 3 commits into
mainfrom
brk.chore/agents-md

Conversation

@brkalow
Copy link
Copy Markdown
Member

@brkalow brkalow commented May 16, 2026

Description

Introduce a basic AGENTS.md file with a few guidelines on changes to the public clerk-js API.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

@vercel
Copy link
Copy Markdown

vercel Bot commented May 16, 2026

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

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment May 16, 2026 3:05am

Request Review

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 16, 2026

🦋 Changeset detected

Latest commit: b8079fe

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 16, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro

Run ID: d874f01c-c42f-47c3-8c11-45e0fff4037a

📥 Commits

Reviewing files that changed from the base of the PR and between 8b52079 and b8079fe.

📒 Files selected for processing (1)
  • .prettierignore
✅ Files skipped from review due to trivial changes (1)
  • .prettierignore

📝 Walkthrough

Walkthrough

This PR adds AGENTS.md with repository contribution and release guidelines for Clerk's JavaScript SDK and UI packages, updates CLAUDE.md to reference AGENTS.md, adds a new changeset file .changeset/orange-dragons-join.md, and adds CLAUDE.md to .prettierignore.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: introducing a basic AGENTS.md file to the repository.
Description check ✅ Passed The description directly relates to the changeset, explaining the purpose of introducing AGENTS.md with guidelines for public clerk-js API changes.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 16, 2026

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/dev-cli

npm i https://pkg.pr.new/@clerk/dev-cli@8566

@clerk/expo

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: b8079fe

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