chore: add CLAUDE.md and correct Node version in README - #453
Merged
Conversation
Add CLAUDE.md with repository guidance for AI assistants: project layout, Node 22 + npm tooling, common commands, the externals-vs-bundled dependency model, and the version-release checklist. Fix the README development-setup note, which still said "Requires Node 12"; the repo targets Node 22 per .nvmrc and package.json engines. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
hamzabenali-okta
force-pushed
the
chore/add-claude-md
branch
from
July 21, 2026 13:39
6359319 to
17d7793
Compare
sauntimo
self-requested a review
July 21, 2026 17:52
sauntimo
approved these changes
Jul 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add CLAUDE.md with repository guidance for AI assistants: project layout, Node 22 + npm tooling, common commands, the externals-vs-bundled dependency model, and the version-release checklist.
Fix the README development-setup note, which still said "Requires Node 12"; the repo targets Node 22 per .nvmrc and package.json engines.
✏️ Changes
Documentation-only change. No application code, dependencies, or build output changed.
CLAUDE.md(new): guidance for AI coding assistants working in this repo — theserver//client//dist/layout, Node 22 + npm tooling, common commands (npm test,lint:js,build,serve:*), the externals-vs-bundled dependency model (externals are resolved from the host module store at runtime and are not bundled, so their versions must be kept in sync betweenauth0-extension.externalsanddependencies), and the multi-place version-release checklist. This captures conventions that are otherwise easy to get wrong in a maintenance-mode repo.README.md: the Development Setup section still said "Requires Node 12 — higher versions not yet supported", which is stale. The repo targets Node 22 (.nvmrcand theenginesfield inpackage.json). Updated the note to Node 22 and pointed at those authoritative sources.No packages were added or updated, so no lockfile / build changes are involved.
📷 Screenshots
N/A — no visual changes.
🔗 References
.nvmrc/package.jsonenginesas the source of truth for the Node version.🎯 Testing
No functional change to test. Reviewers can verify by reading the two files and confirming the README Node version now matches
.nvmrcandpackage.jsonengines.🚫 This change has been tested in a Webtask
🚫 This change has unit test coverage
🚫 This change has integration test coverage
🚫 This change has been tested for performance
🚀 Deployment
✅ This can be deployed any time — documentation only, no runtime impact, no lockstep dependency.
🎡 Rollout
In order to verify that the deployment was successful we will confirm the two files are present on the default branch as intended. There is nothing to verify at runtime — the change does not affect the deployed extension.
🔥 Rollback
We will rollback if the documentation is found to be inaccurate or misleading.
📄 Procedure
Revert the merge commit. Since this is a docs-only change with no runtime effect, revert is safe at any time and requires no redeploy.
🖥 Appliance
Note to reviewers: ensure that this change is compatible with the Appliance. This is a documentation-only change with no runtime or build impact, so no Appliance compatibility concerns apply.