Skip to content

Commit ea2793b

Browse files
author
Rajat Saxena
committed
Added AGENTS.md
1 parent 99fc07f commit ea2793b

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

AGENTS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Development Tips
2+
3+
- Use `pnpm` as package manager.
4+
- The project is structured as a monorepo i.e. a pnpm workspace. The apps are in `apps` folder and re-usable packages are in `packages`.
5+
- Command for running script in a workspace: `pnpm --filter <workspace> <command>`.
6+
- Command for running tests: `pnpm test`.
7+
- The project uses shadcn for building UI so stick to its conventions and design.
8+
- In `apps/web` workspace, create a string first in `apps/web/config/strings.ts` and then import it in the `.tsx` files, instead of using inline strings.
9+
- When working with forms, always use refs to keep the current state of the form's data and use it to enable/disable the form submit button.
10+
- Check the name field inside each package's package.json to confirm the right name—skip the top-level one.
11+
12+
## Testing instructions
13+
14+
- Always add or update test when introducing changes to `apps/web/graphql` folder, even if nobody asked.
15+
- Run `pnpm test` to run the tests.
16+
- Fix any test or type errors until the whole suite is green.
17+
18+
## PR instructions
19+
20+
- Always run `pnpm lint` and `pnpm prettier` before committing.

0 commit comments

Comments
 (0)