feat: cursor rules for code review

Signed-off-by: Junaid Rahim <[email protected]>

Author: junaidrahim

.cursor/rules/code-review.mdc

@@ -0,0 +1,55 @@
+---
+description: When asked to perform a code review for a module, class or function.
+globs:
+alwaysApply: false
+---
+# Code Review Guidelines
+
+When asked to perform a code review for a module, class or function.
+
+## Code Style
+
+Ensure the code adheres to the development standards outlined in [standards.mdc](mdc:.cursor/rules/standards.mdc):
+
+
+## Tests
+
+All code changes must include appropriate tests as defined in [testing.mdc](mdc:.cursor/rules/testing.mdc):
+
+
+## Documentation
+
+Verify documentation standards from [standards.mdc](mdc:.cursor/rules/standards.mdc) and [documentation.mdc](mdc:.cursor/rules/documentation.mdc):
+
+
+## API Semantics
+
+- **Interface Design**
+    - Clear and consistent API contracts
+    - Proper input validation and output formatting
+    - Backward compatibility considerations
+    - Appropriate HTTP status codes and responses
+
+- **Data Flow**
+    - Proper handling of inputs, transformations, and outputs
+    - Validation of data at boundaries
+    - Consistent data structures and formats
+
+## Contributing Guide
+
+Please ensure the change adheres to the pull request guidelines in [CONTRIBUTING.md](mdc:CONTRIBUTING.md):
+
+## Review Checklist
+
+- Code follows [standards.mdc](mdc:.cursor/rules/standards.mdc) style guidelines
+- Tests follow [testing.mdc](mdc:.cursor/rules/testing.mdc) requirements
+- Logging uses [logging.mdc](mdc:.cursor/rules/logging.mdc) standards
+- Documentation is updated per [documentation.mdc](mdc:.cursor/rules/documentation.mdc)
+- PR follows [CONTRIBUTING.md](mdc:CONTRIBUTING.md) guidelines
+- Security considerations addressed
+- Performance implications considered
+- Resource management properly handled
+- Error handling is comprehensive
+- API contracts are clear and consistent
+
+Refer to the [CONTRIBUTING.md](mdc:CONTRIBUTING.md) for guidelines for contributors

.cursor/rules/documentation.mdc

@@ -4,11 +4,11 @@ globs: application_sdk/**/*.py
 alwaysApply: false
 ---
 Update conceptual documentation when SDK code changes.
-  A file within the Application SDK has been modified: `{trigger_file_path}`.
+A file within the Application SDK has been modified: `{trigger_file_path}`.
 
-  **Action Required:** Please review the changes in this file and update the corresponding conceptual documentation under `docs/docs/concepts/` to ensure it accurately reflects the current code. Keeping documentation synchronized with the code is crucial for maintainability.
+**Action Required:** Please review the changes in this file and update the corresponding conceptual documentation under `docs/docs/concepts/` to ensure it accurately reflects the current code. Keeping documentation synchronized with the code is crucial for maintainability.
 
-  **Module to Concept Doc Mapping:**
+**Module to Concept Doc Mapping:**
   *   `application_sdk/application/**` -> `docs/docs/concepts/application.md` (Covers both simple and specialized workflow applications. The `BaseApplication` class is the generic entry point for all workflow-driven applications.)
   *   `application_sdk/server/**` -> `docs/docs/concepts/server.md` (Covers server abstractions, FastAPI integration, and API endpoint patterns.)
   *   `application_sdk/handlers/**` -> `docs/docs/concepts/handlers.md` (Covers handler interfaces and custom handler logic.)
@@ -22,4 +22,4 @@ Update conceptual documentation when SDK code changes.
   *   `application_sdk/worker.py` -> `docs/docs/concepts/worker.md` (Covers worker orchestration and Temporal worker management.)
   *   `docs/docs/concepts/application_sql.md` -> Specialized SQL workflow application patterns and examples.
 
-  *(Note: Carefully examine the code changes to determine the exact impact and which documentation file(s) require updates. For application changes, review both simple and specialized application patterns.)*
+*(Note: Carefully examine the code changes to determine the exact impact and which documentation file(s) require updates. For application changes, review both simple and specialized application patterns.)*

.cursor/rules/logging.mdc

@@ -1,53 +1,53 @@
 ---
-description:
-globs: application_sdk/**/*.py
+description: When asked to add or improve logs for a given module or file.
+globs:
 alwaysApply: false
 ---
 # Logging Guidelines
 
-- **Logger Configuration**
-    - Use `AtlanLoggerAdapter` for all logging
-    - Configure loggers using `get_logger(__name__)`
-    - Use structured logging with context
-    - Include request IDs in logs
-    - Use appropriate log levels:
-        - DEBUG: Detailed information for debugging
-        - INFO: General operational information
-        - WARNING: Warning messages for potential issues
-        - ERROR: Error messages for recoverable errors
-        - CRITICAL: Critical errors that may cause system failure
-        - ACTIVITY: Activity-specific logging
-
-- **Log Format**
-    ```python
-    "<green>{time:YYYY-MM-DD HH:mm:ss}</green> <blue>[{level}]</blue> <cyan>{extra[logger_name]}</cyan> - <level>{message}</level>"
-    ```
-
-- **Logging Best Practices**
-    - Include relevant context in log messages
-    - Use structured logging for machine processing
-    - Log exceptions with stack traces
-    - Include request IDs in distributed systems
-    - Use appropriate log levels
-    - Avoid logging sensitive information
-    - Include workflow and activity context in Temporal workflows
-
-- **Example Usage**
-    ```python
-    from application_sdk.observability.logger_adaptor import get_logger
-
-    logger = get_logger(__name__)
-
-    # Basic logging
-    logger.info("Operation completed successfully")
-
-    # Logging with context
-    logger.info("Processing request", extra={"request_id": "123", "user": "john"})
-
-    # Error logging
-    try:
-        # Some operation
-        pass
-    except Exception as e:
-        logger.error("Operation failed", exc_info=True)
-    ```
+This rule establishes standardized logging practices for the Application SDK using `AtlanLoggerAdapter`.
+
+## Logger Configuration
+
+- Always configure loggers using the `get_logger(__name__)` function in `application_sdk.observability.logger_adaptor.py` for all logging needs.
+  - This creates a `AtlanLoggerAdapter` singleton instance that can used multiple times.
+- Use structured logging with context
+- Include request IDs in logs
+- Use appropriate log levels:
+    - DEBUG: Detailed information for debugging
+    - INFO: General operational information
+    - WARNING: Warning messages for potential issues
+    - ERROR: Error messages for recoverable errors
+    - CRITICAL: Critical errors that may cause system failure
+    - ACTIVITY: Activity-specific logging
+
+## Logging Best Practices
+
+- Include relevant context in log messages
+- Use structured logging for machine processing
+- Log exceptions with stack traces
+- Include request IDs in distributed systems
+- Use appropriate log levels
+- Avoid logging sensitive information
+- Include workflow and activity context in Temporal workflows
+
+## Example Usage
+
+```python
+from application_sdk.observability.logger_adaptor import get_logger
+
+logger = get_logger(__name__)
+
+# Basic logging
+logger.info("Operation completed successfully")
+
+# Logging with context
+logger.info("Processing request", extra={"request_id": "123", "user": "john"})
+
+# Error logging
+try:
+    # Some operation
+    pass
+except Exception as e:
+    logger.error("Operation failed", exc_info=True)
+```

.cursor/rules/testing.mdc

@@ -7,7 +7,6 @@ alwaysApply: false
 
 - Run the unit tests using the command: `uv run pytests tests/`
 
-
 - **Test Framework**
     - Write tests before fixing bugs
     - Keep tests readable and maintainable