Cursor Rules

AI Coding Agent Configuration Rules

Project Documentation and Context
	•	Always Read Documentation: Thoroughly read existing Readme.md files in each directory before starting work to fully grasp the current state and context.
	•	Maintain Up-to-Date Documentation: Update or create a Readme.md in each folder immediately after making any changes, clearly documenting all edits and additions.
	•	Use Progress Tracking: Follow provided task lists (progress.md) iteratively. If no such list is provided and multiple issues emerge, proactively create a progress.md to track tasks and progress explicitly.

Knowledge Base Usage (cursor_project_rules)
	•	Contextual Coding Only: Always rely on the cursor_project_rules folder as your single source of truth for project rules and guidelines.
	•	Clarify Before Coding: Never assume project context. If anything is unclear, explicitly request clarification referencing the cursor_project_rules.

Verification and Accuracy
	•	Prevent Redundancy: Verify thoroughly that features or fixes are not already implemented to avoid duplication.
	•	Accuracy First: Double-check all context-derived information before relying on it. Do not make speculative assumptions.

Coding Workflow
	•	Iterative, Structured Workflow: Complete tasks incrementally following provided markdown files clearly.
	•	Single-File, Single-Step Edits: Submit changes one file at a time, clearly and concisely, without multi-step instructions or redundant explanations.

Strict Quality and Solution Standards
	•	No Hotfixes or Shortcuts: Never resort to temporary hacks or quick fixes. Always implement robust, permanent solutions.
	•	Preserve Functionality Completely: Never simplify solutions by commenting out, deleting, or disabling existing features.
	•	Explicit Requirements Only: Implement strictly what is explicitly requested. Seek clarification if the request is ambiguous.
	•	Avoid Generated/Compiled Directories: Never edit or suggest changes within generated (dist) or compiled directories.

Priority and Business Logic
	•	Prioritize Core Functionality: Focus first on tasks critical to the application’s primary business logic.
	•	Prioritize Critical Fixes: Immediately address high-impact bugs or errors, then proceed to less critical issues.

Coding Standards and Practices
	•	Consistency in Style: Strictly adhere to existing project coding conventions.
	•	Explicit Naming: Ensure all variables and functions are clearly and descriptively named.
	•	Avoid Magic Numbers: Always define meaningful constants rather than using hardcoded values.
	•	Modular and Maintainable Code: Promote modular code structure for easy maintenance and reusability.

Performance and Security
	•	Optimize Performance: Recommend the most efficient and performant solutions available.
	•	Security as a Priority: Carefully evaluate and communicate any security implications of code changes.

Robustness, Testing, and Validation
	•	Comprehensive Error Handling: Include robust error handling and meaningful logging.
	•	Include Unit Tests: Always recommend or provide unit tests alongside new or changed functionalities.
	•	Validate with Assertions: Use assertions proactively to catch logical errors early.
	•	Consider Edge Cases Thoroughly: Ensure logic robustly handles all potential edge cases.

Compatibility and Versioning
	•	Check Version Compatibility: Ensure solutions fully align with specified framework or language versions. Clearly document or provide alternative approaches if conflicts occur.

Communication Efficiency
	•	Avoid Unnecessary Commentary: Provide concise, actionable feedback without unnecessary apologies, confirmations, or whitespace suggestions.
	•	Direct File Linking: Always provide direct links to real files, not generated or inferred contexts.
	•	Minimal Summaries: Only summarize actions if explicitly requested.

Automated Verification
	•	Include Automated Tests: Whenever altering functionality, provide or recommend automated verification methods rather than manual checking.
	•	Avoid Unnecessary Edits: Do not suggest changes unless explicitly required by task instructions.

These guidelines ensure clarity, professionalism, and strict adherence to best practices, fostering a reliable, maintainable, and well-documented project.