-
Notifications
You must be signed in to change notification settings - Fork 119
AGENTS: Multiple improvements for frontend #3725
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
AGENTS: Multiple improvements for frontend #3725
Conversation
…ot only backend Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
Signed-off-by: Patrick José Pereira <patrickelectric@gmail.com>
Reviewer's guide (collapsed on small PRs)Reviewer's GuideUpdates the AGENTS persona and common pitfalls documentation to better reflect full-stack (frontend and backend) responsibilities, including more precise frontend tech stack details and new frontend-specific pitfalls. Flow diagram for updated backend and frontend pitfalls documentationflowchart TD
A[AGENTS_persona] --> B[Responsibilities]
B --> C[Backend_focus]
B --> D[Frontend_focus]
subgraph Backend_pitfalls
C1[Check_existing_dependencies_in_pyproject_toml]
C2[Reuse_aiohttp_sessions_or_use_context_managers]
C3[Register_service_in_pyproject_toml_start_blueos_core_and_nginx_conf]
C4[Avoid_blocking_IO_use_async_versions]
C5[Use_versioned_api_route_1_0_for_API_versioning]
end
subgraph Frontend_pitfalls
D1[Use_Vuetify_theme_colors_primary_success_etc]
D2[Keep_one_component_per_vue_file]
D3[Clear_intervals_and_timeouts_in_beforeDestroy_and_use_OneMoreTime]
D4[Prefer_object_destructuring_over_direct_property_access]
end
C --> Backend_pitfalls
D --> Frontend_pitfalls
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey - I've left some high level feedback:
- In the frontend pitfalls section, the guidance on 'Direct property access' is a bit vague—consider clarifying when and why destructuring is preferred (and when direct access is acceptable), ideally with a brief example.
- The reference to
OneMoreTimein the frontend cleanup pitfall might be unclear to readers unfamiliar with it—adding a short description or context for what it is and when to use it would improve the guideline.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In the frontend pitfalls section, the guidance on 'Direct property access' is a bit vague—consider clarifying when and why destructuring is preferred (and when direct access is acceptable), ideally with a brief example.
- The reference to `OneMoreTime` in the frontend cleanup pitfall might be unclear to readers unfamiliar with it—adding a short description or context for what it is and when to use it would improve the guideline.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Summary by Sourcery
Update agent guidelines to better cover frontend development practices and clarify the developer persona.
Documentation:
Chores: