manager-common

What problem does it solve?

This Skill provides a standardized set of guidelines and principles for implementing manager classes, ensuring consistency in responsibility separation, state transitions, API contracts, and concurrency control across different modules.

Core Features & Use Cases

• Standardized Design Principles: Enforces principles like Single Responsibility, Open/Closed, and Dependency Inversion for robust manager implementations.
• Lifecycle Management: Defines clear states (disabled, initializing, enabled, closing) and manages transitions for reliable component initialization and shutdown.
• API Contract Enforcement: Ensures public methods have clear type hints, docstrings, and consistent error handling strategies.
• Concurrency Control: Provides guidelines for managing concurrent access to shared resources and preventing race conditions.
• Error Handling & Logging: Establishes best practices for detailed error reporting and effective logging to aid in troubleshooting.
• Use Case: When developing a new feature that requires managing multiple underlying services (e.g., a translation manager coordinating different translation APIs), these guidelines ensure the manager is built with a predictable lifecycle, clear error reporting, and safe concurrent operation.

Quick Start

Follow these guidelines when implementing a new manager class to ensure consistency and robustness.