chore(claude): add claude.md files for common packages#7082
Open
shaejaz wants to merge 6 commits into
Open
Conversation
Up to standards ✅🟢 Issues
|
More templates
algoliasearch-helper
instantsearch-ui-components
instantsearch.css
instantsearch.js
react-instantsearch
react-instantsearch-core
react-instantsearch-nextjs
react-instantsearch-router-nextjs
vue-instantsearch
commit: |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds repository- and package-level CLAUDE.md documentation (plus .claude/commands/*) to give AI tooling and contributors a concise architectural map and workflow guidance for the InstantSearch monorepo. This is a docs-only PR intended to standardize “where changes go” across connector → flavor wrapper → shared UI layers.
Changes:
- Add root
CLAUDE.mddescribing monorepo architecture, conventions, and common commands. - Add per-package
CLAUDE.mddocs for key packages (InstantSearch core, shared UI components, React/Vue flavors, helper, Next.js integrations). - Add Claude command docs under
.claude/commands/for preflight checks and cross-flavor connector-option rollout.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/vue-instantsearch/CLAUDE.md | Documents Vue package layout, dual Vue2/Vue3 workflow, and shared UI usage via renderCompat. |
| packages/react-instantsearch/CLAUDE.md | Documents React layer split (core hooks vs DOM widgets) and local/shared UI conventions. |
| packages/react-instantsearch-router-nextjs/CLAUDE.md | Documents Pages Router adapter responsibilities, API surface, and e2e workflow. |
| packages/react-instantsearch-nextjs/CLAUDE.md | Documents App Router SSR/hydration architecture and testing workflow. |
| packages/instantsearch.js/CLAUDE.md | Documents connector/widget layout and where cross-flavor behavior should be implemented/tested. |
| packages/instantsearch-ui-components/CLAUDE.md | Documents shared UI factory/renderer pattern, typing/classname conventions, and testing approach. |
| packages/algoliasearch-helper/CLAUDE.md | Documents helper role, stability expectations, and package-specific conventions (CJS, hand-written d.ts). |
| CLAUDE.md | Adds repo-wide architecture map, “where work goes” routing, commands, and conventions. |
| .claude/commands/preflight.md | Adds a reusable pre-push checklist procedure (lint/types/tests/commit message). |
| .claude/commands/expose-option.md | Adds a cross-flavor checklist for surfacing a connector option through JS/React/Vue + tests. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
shaejaz
requested review from
a team,
FabienMotte and
afrencalg
and removed request for
a team
FabienMotte
approved these changes
Jun 26, 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
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 AI-coding context docs for the InstantSearch monorepo
Adds Claude Code / AGENTS.md configuration to help AI tools navigate the repo's connector → flavor-wrapper → shared-UI architecture.
What's included
CLAUDE.md— repo map, per-layer "where work goes" routing, and cross-flavor change conventions (settle the contract in the connector first, then React + Vue, then common tests).CLAUDE.mdforinstantsearch.js,react-instantsearch,vue-instantsearch,algoliasearch-helper, and the two Next.js integrations — each documenting that package's layout, working commands, and gotchas.AGENTS.md— symlink toCLAUDE.mdfor cross-tool portability (Codex/Cursor)./expose-option(recipe for surfacing a connector option across all flavors) and/preflight(pre-push lint/types/tests/commit check)..claude/rules/e2e.md— Playwright/WebdriverIO e2e testing guide.Docs-only; no library code changes.