diff --git a/agents.md b/agents.md new file mode 100644 index 00000000..c5ab16c7 --- /dev/null +++ b/agents.md @@ -0,0 +1,34 @@ +# Studio Project - Agent Context + +## Overview + +Studio is a visual app builder for the Frappe Framework. It allows developers to build modern web applications using a drag & drop layout builder, wire Frappe Framework data sources, edit component props and slots, and create reactive apps with dynamic variables and scripts. + +## Agent Guidelines & Code Conventions + +1. **Guidelines for writing good code for a developer** + - Choose clean code over clever code. + - Write object oriented code as much as possible. + - Keep function sizes small, ideally 10 lines. + - Keep files small, between 100 and 300 lines + - Keep directories or module small, fewer than 15 files. + - Avoid abbreviations. + - Use standard API as much as possible. + - Reuse. Write as little code as possible. + - Build the minimum working code, then iterate towards your goals. + - Don't add unnecessary dependencies unless required. + - Don't add unnecessary comments for simple code. Use it only when the code is not self-explanatory. +2. **Frontend Development:** + - Rely on `frappe-ui` components (e.g., buttons, dialogs, inputs) instead of building them from scratch (local copy in ./frappe-ui/) + - Use Tailwind CSS for styling. Avoid writing raw CSS (`.css` files or `