You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AI.md
+20-5Lines changed: 20 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,20 @@
8
8
9
9
## 🚦 Strict Workflow Protocol
10
10
Before modifying, generating, or deleting any files, the agent MUST follow these steps in exact order:
11
+
11
12
1.**Plan First:** Present a comprehensive architectural review, design summary, or pseudo-code strategy. Wait for explicit user greenlight.
12
13
2.**Git Branching:** Checkout to a distinct feature or refactor branch from `main` using the Conventional Commits specification (e.g., `feat(backend)/...`, `refactor(frontend)/...`).
13
-
3.**Execution:** Apply the changes within the tightly scoped workspace directory.
14
-
4.**Finalize:** Upon user validation, stage and commit changes with concise, structured commit messages.
15
-
5.**Documentation:** Auto-generate a pull request summary titled `pr_description.md` in the project root adhering to the workspace markdown template.
16
-
14
+
3.**Execution:** Apply code modifications within the tightly scoped workspace directory.
15
+
4.**Code Quality & Validation:** Before asking for user confirmation, you must ensure the code is clean and passes all local checks. Run the following commands based on the affected workspace:
16
+
-**If Backend changed:** Run `make format` followed by `make lint` inside the `/backend` directory.
17
+
-**If Frontend changed:** Run `npm run format` followed by `npm run lint` inside the `/frontend` directory.
18
+
5.**Testing Suite Execution:** Run the test suite to ensure zero regressions. You must invoke tests in **non-interactive, run-once mode** so the process does not hang:
19
+
-**Backend:** Run `make test` from the `/backend` folder.
20
+
-**Frontend:** Run `npm run test:unit -- --run` (or the equivalent non-watching continuous integration command) from the `/frontend` folder.
21
+
6.**Test Coverage Prompt:** Once checks pass, explicitly prompt the user: *"Would you like me to prepare or update any unit tests specific to these changes before we commit?"*
22
+
7.**Finalize:** Upon user validation, stage and commit changes with concise, structured commit messages following the Conventional Commits format.
23
+
8.**Documentation:** Auto-generate or update a pull request summary saving it directly to `pr_description.md` in the project root. The layout of this file must copy the formal structure defined in the repository's native GitHub file: `.github/PULL_REQUEST_TEMPLATE.md`.
24
+
9.
17
25
---
18
26
19
27
## 🐍 Backend Specifics (`/backend`)
@@ -28,4 +36,11 @@ Before modifying, generating, or deleting any files, the agent MUST follow these
28
36
*Focus rules when operating within the frontend directory:*
29
37
-**Framework Stack:** Vue 3 (Composition API, `<script setup>`), Vite, Tailwind CSS v4, and Shadcn-vue via `reka-ui`.
30
38
-**State Management:** Server state must be tightly managed via TanStack Query (Vue Query). Pinia is strictly reserved for transient global application primitives like Authentication.
31
-
-**Data Synchronization:** UI component tables must synchronize filtering, sorting, and pagination state unidirectionally using TanStack Table's native state updaters feeding directly into `vue-router` query parameters. Avoid redundant watchers or cyclical loop patterns.
39
+
-**Data Synchronization:** UI component tables must synchronize filtering, sorting, and pagination state unidirectionally using TanStack Table's native state updaters feeding directly into `vue-router` query parameters. Avoid redundant watchers or cyclical loop patterns.
40
+
41
+
---
42
+
43
+
## 🏁 Completion Signal
44
+
When every protocol step is completely finished, your final output to the user MUST explicitly print this statement on a standalone line for tracking visibility:
45
+
46
+
🚀 **Success! Pull Request documentation has been successfully generated/updated in `pr_description.md`.**
0 commit comments