Hey is a decentralized and permissionless social media app built with Lens Protocol 🌿
Add repository agent guidelines (#5650)
authored by
GitHub
13ebb04a
904ea553
+43
+42
AGENTS.md
+42
AGENTS.md
···
1
+
# Repository Agent Guidelines
2
+
3
+
This repository follows coding and collaboration conventions summarized from `.cursorrules`.
4
+
5
+
## General Principles
6
+
7
+
- Implement requests thoroughly and follow requirements precisely.
8
+
- Think through solutions step by step before writing code.
9
+
- Produce clean, fully functional code aligned with best practices.
10
+
- Prioritize readability over performance and avoid duplication.
11
+
- Include all necessary imports and use clear, descriptive names.
12
+
- Remove placeholders or incomplete sections before committing.
13
+
14
+
## Tech Stack
15
+
16
+
- React and Vite with TypeScript
17
+
- HeadlessUI, Tailwind CSS, Radix
18
+
- Apollo GraphQL, Hono
19
+
- Prisma with Postgres
20
+
- Zustand, TanStack React Query
21
+
- Zod for validation
22
+
- Prosekit with Remark and Rehype
23
+
24
+
## Implementation Guidelines
25
+
26
+
- Use early returns and guard clauses.
27
+
- Always export default React components at the end of each file.
28
+
- Style elements with Tailwind classes only.
29
+
- Name event handlers with a `handle` prefix (e.g., `handleClick`).
30
+
- Add accessibility attributes such as `tabIndex`, `aria-label`, and keyboard handlers.
31
+
- Prefer arrow functions and define types or interfaces for props.
32
+
- Place files in pnpm workspaces and keep packages isolated.
33
+
- Handle errors early with custom error types when appropriate.
34
+
- Favor derived state and memoization instead of excessive `useEffect`.
35
+
- Use interfaces for props and avoid enums, preferring literal types.
36
+
- Follow camelCase naming and use verbs for boolean flags.
37
+
- Organize exports, subcomponents, helpers, static content, and types within files.
38
+
39
+
## References
40
+
41
+
- [Lens Protocol Docs](https://lens.xyz/docs/protocol)
42
+
- [Grove Storage Docs](https://lens.xyz/docs/storage)