You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a TypeScript project that implements a frontend build tooling called Vite. Please follow these guidelines when contributing:
2
+
3
+
## Code Standards
4
+
5
+
### Required Before Each Commit
6
+
7
+
- Run `pnpm run lint` to ensure that your code adheres to the code standards.
8
+
- Run `pnpm run format` to format your code.
9
+
10
+
### Development Flow
11
+
12
+
- Build: `pnpm run build`
13
+
- Test: `pnpm run test` (uses Vitest and Playwright)
14
+
15
+
## Repository Structure
16
+
17
+
-`docs/`: Documentation.
18
+
-`packages/create-vite`: Contains the source code for the `create-vite` command.
19
+
-`packages/plugin-legacy`: Contains the source code for `@vitejs/plugin-legacy`.
20
+
-`packages/vite`: Contains the source code for the Vite core.
21
+
-`playground/`: E2E tests
22
+
23
+
## Key Guidelines
24
+
25
+
1. Follow TypeScript best practices.
26
+
2. Maintain existing code structure and organization.
27
+
3. Write tests for new functionality. Prefer unit tests if it can be tested without using mocks. E2E tests should be added in the `playground/` directory.
28
+
4. Never write comments that explain what the code does. Instead, write comments that explain why the code does what it does.
29
+
5. Suggest changes to the documentation if public API changes are made.
0 commit comments