Skip to content

Commit b7f0746

Browse files
committed
chore: clarify copilot instructions
1 parent 2aca533 commit b7f0746

2 files changed

Lines changed: 10 additions & 9 deletions

File tree

.github/copilot-instructions.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ pnpm install --frozen-lockfile
2424

2525
**Node.js:** Version 20.x is required (CI uses Node 20)
2626
**pnpm:** Version 9.15.4 (managed via packageManager field)
27-
**.NET SDK:** Version 6.0.x required for building the test runner (packages/devextreme/testing/runner)
27+
**.NET SDK:** Version 8.0.x required for building the test runner (packages/devextreme/testing/runner)
2828

2929
### First-Time Setup
3030

@@ -159,11 +159,10 @@ pnpm run clean
159159
7. NPM package preparation
160160

161161
**Important environment variables:**
162-
- `DEVEXTREME_TEST_CI=true` - Enables test mode (skips some production steps)
163-
- `BUILD_ESM_PACKAGE=true` - Builds ESM modules
162+
- `DEVEXTREME_TEST_CI=true` - Enables test mode (skips building npm package)
163+
- `BUILD_ESM_PACKAGE=true` - Builds ESM modules (skips building npm package)
164164
- `BUILD_TESTCAFE=true` - Builds for TestCafe tests
165165
- `BUILD_TEST_INTERNAL_PACKAGE=true` - Builds internal test package
166-
- `BUILD_INPROGRESS_RENOVATION=true` - Includes in-progress renovation components
167166

168167
## Testing
169168

@@ -243,7 +242,7 @@ npm run lint-staged
243242
**3. Build All (`.github/workflows/build_all.yml`):**
244243
- Runs `pnpm run all:build`
245244
- Tests custom bundle creation
246-
- Requires .NET 6.0.x
245+
- Requires .NET 8.0.x
247246
- Timeout: varies
248247

249248
**4. Wrapper Tests (`.github/workflows/wrapper_tests.yml`):**
@@ -253,7 +252,7 @@ npm run lint-staged
253252
- Timeout: 20 minutes
254253

255254
**5. QUnit Tests (`.github/workflows/qunit_tests-renovation.yml`):**
256-
- Builds with `DEVEXTREME_TEST_CI=true` and `BUILD_INPROGRESS_RENOVATION=true`
255+
- Builds with `DEVEXTREME_TEST_CI=true`
257256
- Runs tests in parallel across multiple constellations
258257
- Timeout: 60 minutes
259258

@@ -319,9 +318,10 @@ pnpm run lint-ts -- --fix
319318
pnpm run vue:regenerate
320319
```
321320

322-
6. **If you modified TypeScript declarations:**
321+
6. **If you modified TypeScript declarations or devextreme-internal-tools:**
323322
```bash
324323
cd packages/devextreme
324+
pnpm run regenerate-all
325325
pnpm run update-ts-reexports
326326
pnpm run update-ts-bundle
327327
```
@@ -337,7 +337,7 @@ pnpm run lint-ts -- --fix
337337
**✅ DO:**
338338
- Always use `pnpm install --frozen-lockfile`
339339
- Build before testing: `pnpx nx build:dev devextreme`
340-
- Run `pnpm run regenerate-all` after modifying wrapper generators
340+
- Run `pnpm run regenerate-all` after modifying wrapper generators, TypeScript declarations, or devextreme-internal-tools (may affect code generators and/or metadata generators)
341341
- Use Nx commands for better caching: `pnpx nx build devextreme`
342342
- Check CI workflows to understand what will be validated
343343

.github/instructions/API_conventions.instructions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
applyTo: "**/packages/devextreme/js/common.d.ts"
2+
applyTo: "**/packages/devextreme/js/**/*.d.ts"
33
---
44

55
When helping me write code or reviewing my existing code, please follow these specific code style conventions:
@@ -16,5 +16,6 @@ When helping me write code or reviewing my existing code, please follow these sp
1616

1717
2. **JSDoc Format - Omit @type:**
1818
- Do not include the `@type` tag in JSDoc comments when the type is already indicated by TypeScript type annotation
19+
- Note: This is correct only when the type is the same in both TS annotation and JSDoc comment.
1920

2021
Consistently apply these conventions to all code you review, suggest, complete.

0 commit comments

Comments
 (0)