Add .cursorrules

[cachafla]

Pull Request Description

What and why?

This PR adds a comprehensive .cursorrules file to the ValidMind Library repository to establish coding standards and development guidelines for AI-assisted development. The .cursorrules file provides detailed guidance for:

• Python package development best practices
• Object-oriented design patterns for core SDK classes
• Test implementation guidelines and conventions
• Error handling and validation patterns
• Documentation standards and notebook organization
• ValidMind-specific development patterns

Before: No standardized guidelines for AI-assisted development
After: Clear, comprehensive development guidelines that ensure consistency across the SDK codebase

How to test

This change introduces documentation/configuration only and doesn't affect runtime behavior:

1. Verify the .cursorrules file is present in the repository root
2. Review the guidelines to ensure they align with current SDK architecture
3. Test AI-assisted development in Cursor to confirm the rules are being applied appropriately

What needs special review?

• Content accuracy: Ensure all guidelines accurately reflect current SDK architecture and best practices
• Completeness: Verify the guidelines cover all major areas of SDK development
• ValidMind-specific patterns: Review the SDK-specific sections for accuracy (test implementation, object initialization, etc.)

Dependencies, breaking changes, and deployment notes

• No dependencies or breaking changes
• No special deployment considerations
• This is a development tooling enhancement only

Release notes

Added comprehensive development guidelines via .cursorrules file to standardize AI-assisted development practices across the ValidMind SDK codebase.

Checklist

• What and why
• Screenshots or videos (Frontend) - N/A
• How to test
• What needs special review
• Dependencies, breaking changes, and deployment notes
• Labels applied - internal or documentation
• PR linked to Shortcut
• Unit tests added (Backend) - N/A (documentation only)
• Tested locally
• Documentation updated (if required)
• Environment variable additions/changes documented (if required) - N/A

[github-actions]

PR Summary

This PR introduces a new documentation file named .cursorrules which outlines the project guidelines for the ValidMind Library. The document covers a wide range of key principles and best practices for Python package development, data science, and machine learning model validation. It details recommendations for:

• Code organization and modularization, emphasizing object-oriented and functional programming paradigms.
• Naming conventions, including the use of snake_case for variables and PascalCase for test names.
• Structuring Python packages with a flat structure and clearly separated public APIs.
• Implementing comprehensive type hints, detailed docstrings, and proper error handling with custom exception classes.
• Best practices for writing and organizing tests, including guidelines for test naming, decoractor usage, and structuring tests by domain and functionality.
• Instructions for integrating tests, handling logging, and managing batch test execution.

This documentation provides clear standards to ensure code consistency, readability, and maintainability across the project, catering to both developers and data scientists working on model validation and documentation tasks.

Test Suggestions

• Verify that new tests adhere to these guidelines in naming, structure, and decorator usage.
• Run a linter or static analysis tool to check for consistency with the naming conventions and code organization principles detailed in the guidelines.
• Review integration tests to ensure that the error handling and logging practices conform to the documentation.
• Create sample tests using the proposed decorators (@test, @tags, @tasks) and validate that they register correctly with the test registry.

[AnilSorathiya]

👍 thanks

[juanmleng]

Looks great!