diff options
| author | Allen Hutchison <[email protected]> | 2025-05-14 17:17:07 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-05-14 17:17:07 -0700 |
| commit | ff36c937338d534d7d0ee87944c60f130aa10d23 (patch) | |
| tree | 80088902a12862c8f117094c328d611076d26a75 | |
| parent | 8ca2390fbf4b6f5cd3e10e864ad8c62f33290a6c (diff) | |
Docs: Add GEMINI.md for project conventions (#352)
| -rw-r--r-- | GEMINI.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/GEMINI.md b/GEMINI.md new file mode 100644 index 00000000..786358d5 --- /dev/null +++ b/GEMINI.md @@ -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. |
