Skip to content

Commit 15c97c7

Browse files
chenjiahanCopilot
andauthored
docs: setup the AGENTS.md file (#6054)
Co-authored-by: Copilot <[email protected]>
1 parent 81ca761 commit 15c97c7

File tree

2 files changed

+28
-7
lines changed

2 files changed

+28
-7
lines changed

.github/copilot-instructions.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Rsbuild - High-Performance Rspack-based Build Tool
1+
# Rsbuild
22

3-
Rsbuild is a monorepo containing the core Rsbuild build tool, plugins, and related packages. It's a high-performance build tool powered by Rspack with TypeScript, JavaScript, React, Vue, and other framework support.
3+
This monorepo contains the Rsbuild build tool, plugins, and related packages. Rsbuild is a high-performance JavaScript build tool powered by Rspack.
44

55
## Setup & Build
66

7-
**Setup (NEVER CANCEL - takes 2+ minutes):**
7+
**Setup (NEVER CANCEL):**
88

99
```bash
1010
npm install corepack@latest -g && corepack enable
@@ -23,13 +23,13 @@ npx nx build @rsbuild/core # Specific package
2323
**Testing:**
2424

2525
```bash
26-
pnpm test # Unit tests (~10s)
27-
pnpm e2e # E2E tests (~60s)
28-
pnpm lint # Lint code (~5s) - REQUIRED before finishing
26+
pnpm test # Unit tests
27+
pnpm e2e # E2E tests
28+
pnpm lint # Lint code - REQUIRED before finishing
2929
pnpm format # Format code
3030
```
3131

32-
**E2E tests (NEVER CANCEL - takes 10+ minutes):**
32+
**E2E tests (NEVER CANCEL):**
3333

3434
```bash
3535
cd e2e && pnpm install && npx playwright install chromium

AGENTS.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# AGENTS.md
2+
3+
This monorepo contains the Rsbuild build tool, plugins, and related packages. Rsbuild is a high-performance JavaScript build tool powered by Rspack.
4+
5+
## Commands
6+
7+
- **Build**: `pnpm build` (all packages) | `npx nx build @rsbuild/core` (specific)
8+
- **Test**: `pnpm test` (unit tests) | `pnpm test:watch` (watch mode) | `pnpm e2e` (E2E tests)
9+
- **Single test**: `pnpm test packages/core/src/foo.test.ts` (unit test) | `pnpm e2e:rspack cli/base/index.test.ts` (E2E test)
10+
- **Lint**: `pnpm lint` (REQUIRED before commits) | `pnpm format` (format code)
11+
12+
## Code style
13+
14+
- **Formatting**: Single quotes, Prettier
15+
- **Types**: TypeScript strict mode
16+
- **Naming**: camelCase files/functions, PascalCase components/classes, kebab-case packages
17+
18+
## Architecture
19+
20+
- **Structure**: Monorepo with `packages/core/` (main), `packages/plugin-*/` (plugins)
21+
- **Testing**: `.test.ts` files, use `rstest` runner

0 commit comments

Comments
 (0)