Docs: Add GEMINI.md for project conventions (#352)

This commit is contained in:
Allen Hutchison 2025-05-14 17:17:07 -07:00 committed by GitHub
parent 8ca2390fbf
commit ff36c93733
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 31 additions and 0 deletions

31
GEMINI.md Normal file
View File

@ -0,0 +1,31 @@
## Building and running
Every time we make a set of changes you should run the following commands:
Build the repo:
npm run build
Run tests:
npm run test
Type Check:
npm run typecheck
Lint and final checks:
npm run preflight
## Writing Tests
When writing tests look at existing tests in packages/server and packages/cli to conform with the conventions in those files.
## Git Repo
The main branch for this project is called "main"
## React
Write idiomatic React code avoiding using useEffect and useRef when possible.
## Comments policy
Only write high-value comments if at all. Avoid talking to the user through comments.