-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy path.rules
More file actions
34 lines (27 loc) · 1001 Bytes
/
.rules
File metadata and controls
34 lines (27 loc) · 1001 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# Project Configuration
## Project Type
- Runtime Environment: Electron
- Language: TypeScript, Rust
- UI Framework: React
- UI Library: Ant Design
## Build Commands
- `npm install`: Install dependencies
- `npm run tsc:check`: Typecheck TypeScript files
- `npm run lint`: Lint TypeScript files
- `npm run rebuild:rust`: Rebuild Rust files
- `npm run build`: Build whole project
## Important Files
- `src/**/*`: TypeScript source code
- `src-rust/**/*`: Rust source code
## General Rules
- Dont add new dependencies unless asked to
- Keep code clean and organized
- Follow coding conventions and style guides
- Run typechecking, linting, building and tests before committing changes
- Keep commit messages concise and descriptive
- Only commit to the current branch
- Run `npm install` after updating dependencies or dev dependencies in `package.json`
# React Rules
- Use performance enhancing techniques such as `useMemo` and `useCallback`
# Rust Rules
- Use error handling instead of panicing