diff --git a/.changeset/orange-dragons-join.md b/.changeset/orange-dragons-join.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/orange-dragons-join.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/.prettierignore b/.prettierignore index ec4d75c8331..67a5a3fc40e 100644 --- a/.prettierignore +++ b/.prettierignore @@ -23,3 +23,4 @@ packages/clerk-js/src/core/resources/index.ts packages/shared/src/compiled /**/CHANGELOG.md renovate.json5 +CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000000..786c572a61f --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,8 @@ +# AGENTS.md + +Clerk's JavaScript SDK and library monorepo. + +## Guidelines + +- 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. +- 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. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 120000 index 00000000000..47dc3e3d863 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1 @@ +AGENTS.md \ No newline at end of file