Skip to content

Commit ead5006

Browse files
committed
Improved AI.md
1 parent 395ca62 commit ead5006

2 files changed

Lines changed: 31 additions & 49 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,17 @@
1-
## 📌 Pull Request Title
1+
## ✨ Overview
22

3-
<!--
4-
Use Conventional Commit format:
5-
<type>(<scope>): <summary>
3+
<!-- What does this PR do and why? (Features, fixes, or refactors) -->
64

7-
Examples:
8-
- feat(frontend): add event editor UI
9-
- fix(backend): correct field validation
10-
- docs(common): update contributing guide
11-
- chore(deps): update frontend packages
12-
-->
5+
## 🛠️ Scope & Verification
136

14-
## ✨ What’s Changed?
7+
**Workspace:**
8+
- [ ] frontend | - [ ] backend | - [ ] common/config
159

16-
<!--
17-
Clearly describe what this PR does. Mention:
18-
- New features
19-
- Fixes
20-
- Refactors
21-
- Docs or config changes
22-
-->
10+
**Checklist:**
11+
- [ ] Manually tested and verified locally
12+
- [ ] Automated suite passes cleanly (formatting, linting, tests)
13+
- [ ] New/updated unit tests included (if applicable)
2314

24-
## 🧪 How to Test It
15+
## 📝 Developer Notes (Optional)
2516

26-
<!--
27-
Explain how to manually test the change, or link to automated test coverage.
28-
If not testable, explain why.
29-
-->
30-
31-
## 📂 Scope
32-
33-
<!-- Choose one or more folders this PR affects -->
34-
- [ ] frontend
35-
- [ ] backend
36-
- [ ] common/shared
37-
- [ ] CI/config
38-
39-
## 📝 Notes (Optional)
40-
41-
<!--
42-
Anything unusual, breaking, or helpful for reviewers.
43-
-->
44-
45-
## ✅ Checklist
46-
47-
- [ ] PR title uses Conventional Commit format
48-
- [ ] Code is clean and commented where needed
49-
- [ ] I’ve manually tested relevant parts
50-
- [ ] I’ve updated docs (if needed)
17+
<!-- Breaking changes, architecture context, or specific areas for review -->

AI.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,20 @@
88

99
## 🚦 Strict Workflow Protocol
1010
Before modifying, generating, or deleting any files, the agent MUST follow these steps in exact order:
11+
1112
1. **Plan First:** Present a comprehensive architectural review, design summary, or pseudo-code strategy. Wait for explicit user greenlight.
1213
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.
1725
---
1826

1927
## 🐍 Backend Specifics (`/backend`)
@@ -28,4 +36,11 @@ Before modifying, generating, or deleting any files, the agent MUST follow these
2836
*Focus rules when operating within the frontend directory:*
2937
- **Framework Stack:** Vue 3 (Composition API, `<script setup>`), Vite, Tailwind CSS v4, and Shadcn-vue via `reka-ui`.
3038
- **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

Comments
 (0)