Skip to content

Commit 4ff81b6

Browse files
authored
chore(repo): Introduce basic AGENTS.md file (#8566)
1 parent 1d2b972 commit 4ff81b6

4 files changed

Lines changed: 12 additions & 0 deletions

File tree

.changeset/orange-dragons-join.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
---
2+
---

.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,4 @@ packages/clerk-js/src/core/resources/index.ts
2323
packages/shared/src/compiled
2424
/**/CHANGELOG.md
2525
renovate.json5
26+
CLAUDE.md

AGENTS.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# AGENTS.md
2+
3+
Clerk's JavaScript SDK and library monorepo.
4+
5+
## Guidelines
6+
7+
- Non-major releases in `packages/clerk-js` and `packages/ui` are pushed out to consuming applications without requiring explicit package updates. Extra care must be put into any changes to these packages.
8+
- The API exposed from the core Clerk class in `packages/clerk-js/src/core/clerk.ts` is a contract that is depended on by internal and external consumers. Changes to this API must be done in a major version to avoid breakage.

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@AGENTS.md

0 commit comments

Comments
 (0)