update claude.md (#269)

This commit was merged in pull request #269.
This commit is contained in:
Arjun Patel
2026-06-11 10:58:36 -07:00
committed by GitHub
parent b9a8529e72
commit 66d53497c5
+7 -6
View File
@@ -1,20 +1,24 @@
# Project Rules # Project Rules
## Architecture ## Architecture
- Electron typescript/react app is in `js/` folder - Electron typescript/react app is in `js/desktop` folder
- Orion is the api server which lives in the `go/` folder - Mobile react native expo app is in `js/mobile`
- Orion is the api server which lives in the `go/` folder along with other workers, jobs, services
- `cpp/` points to our prototype of a C++ Qt widgets client - `cpp/` points to our prototype of a C++ Qt widgets client
Whenever implementing anything, make sure to take into account best practices without over-engineering. Whenever implementing anything, make sure to take into account best practices without over-engineering.
## Electron App ## Electron App
### Quality ### Quality
We care about overall architectural quality and keeping consistent patterns according to best practices. We care about overall architectural quality and keeping consistent patterns according to best practices. Feel free to move stuff around to make things more elegant, instead of bolting on features.
Another tradeoff we make is simpler, maintainable code over clever behavior. Another tradeoff we make is simpler, maintainable code over clever behavior.
As an example, we have as high of a bar as a product team like Linear and Apple, which outputs high quality software. Let's avoid slop at all costs. As an example, we have as high of a bar as a product team like Linear and Apple, which outputs high quality software. Let's avoid slop at all costs.
### Comments
Don't add non-essential comments everywhere. Clean them up if so.
### Package Manager ### Package Manager
- Use **yarn** (not npm) for all dependency management - Use **yarn** (not npm) for all dependency management
@@ -25,6 +29,3 @@ Whenever possible, we should use the design system components. If we need to add
When adding a feature on the client side, make sure that the api actually supports it by just checking orion implementation all the way through. When adding a feature on the client side, make sure that the api actually supports it by just checking orion implementation all the way through.
IF you find that the API is poorly designed, please suggest changes to improve the client experience. IF you find that the API is poorly designed, please suggest changes to improve the client experience.
## Verification
Check using `yarn compile` which lives in the package.json as a script.