-
Notifications
You must be signed in to change notification settings - Fork 0
Add repository-level AGENT.md guidance for coding agents #7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| # Agent Guide | ||
|
|
||
| This repository is `@bquery/ui`, a framework-agnostic Web Components library built with TypeScript, Vite, Bun, Storybook, and VitePress. | ||
|
|
||
| ## What lives where | ||
|
|
||
| - `src/components/` – component implementations | ||
| - `src/tokens/` – design tokens | ||
| - `src/theme/` – theme helpers and CSS variables | ||
| - `src/i18n/` – localization utilities | ||
| - `src/utils/` – shared helpers | ||
| - `docs/` – VitePress documentation | ||
| - `stories/` – Storybook stories | ||
| - `tests/` – Bun-based test suite | ||
|
|
||
| ## Preferred workflow | ||
|
|
||
| 1. Keep changes focused and consistent with existing component patterns. | ||
| 2. Update documentation when behavior or public APIs change. | ||
| 3. Avoid unrelated refactors while addressing a targeted issue. | ||
| 4. Prefer accessibility, composability, and API consistency improvements. | ||
|
|
||
| ## Setup and validation | ||
|
|
||
| Install dependencies with Bun: | ||
|
|
||
| ```bash | ||
| bun install --frozen-lockfile | ||
| ``` | ||
|
|
||
| If Bun is not installed globally in your environment, use: | ||
|
|
||
| ```bash | ||
| npx bun install --frozen-lockfile | ||
| ``` | ||
|
|
||
| Use these commands to validate work: | ||
|
|
||
| ```bash | ||
| npm run lint:types | ||
| npm run test | ||
| npm run build | ||
| npm run build:docs | ||
| ``` | ||
|
|
||
| If Bun is not installed globally, use `npx bun test` instead of `npm run test`. | ||
|
|
||
| ## Project-specific notes | ||
|
|
||
| - `bun.lock` is the source of truth for dependencies; `package-lock.json` is ignored. | ||
| - Tests preload `tests/setup.ts` through `bunfig.toml`. | ||
| - Documentation uses Markdown in `docs/` and the root `README.md`. | ||
| - Storybook stories live in `stories/` and should stay aligned with component behavior. | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.